Skip to content

[CLI] Path MVP CLI #2

@Olshansk

Description

@Olshansk

Objective

Create a path CLI foundation with MVP functionality to which we will add to over time.

Origin Document

This discussion:

Screenshot 2024-08-22 at 11 19 00 AM

Along with this foundation in the poktroll repo:

Screenshot 2024-08-22 at 11 19 14 AM

Goals

  • Create the foundation for the path CLI

Deliverables

  • Identify which golang CLi framework we want to use; [spf13/cobra](https://github.com/spf13/cobra, https://github.com/urfave/cli
  • At a minimum, provide the following functionality:
    • path gateway start; starts the gateway process and will be used as the entrypoint from docker files
    • path gateway scaffold; walks the user through a series of questions and outputs a yaml file
    • path test relay send; a helper to send a test relay
  • Provide short & long help messages

Non-goals / Non-deliverables

  • Create a fully-fledged and documented CLI with all the features we need

General deliverables

  • Comments: Add/update TODOs and comments alongside the source code so it is easier to follow.
  • Testing: Add new tests (unit and/or E2E) to the test suite.
  • Makefile: Add new targets to the Makefile to make the new functionality easier to use.
  • Documentation: Update architectural or development READMEs; use mermaid diagrams where appropriate.

Creator: @Olshansk
Co-Owners: @fredteumer @adshmh @commoddity

Metadata

Metadata

Assignees

Labels

cliEverything related to the path CLI

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions