Skip to content

[CLI] package it and create a binary named p1 #366

@deblasis

Description

@deblasis

Objective

Package the V1 CLI entrypoint into a package binary.

Origin Document

Context

Instructions on installing the Pocket V0 CLI can be found here. The source code to the V1 CLI implementation can be found here but is not yet packaged into a binary.

Example

The CLI today can be used by providing arguments to go run app/client/*.go from the source of the directory. A detailed flow and example is available here: here: #169.

Naming

Our CNO (Chief Naming Officer) deliberated that the name should fittingly be p1 🙂

image

Goals

  • Make sure that it's possible to execute the new p1 binary locally
  • Make it easy for developers to install the p1 using go tooling

Deliverable

  • Update Makefile with new targets to build & install the client library
  • Update any relevant github workflows to build, verify and update the packaged binary automatically
  • Update any relevant documentation referencing the client binary

Non-goals / Non-deliverables

  • Any behavioural change in the codebase

General issue deliverables

  • Update the appropriate CHANGELOG
  • Update any relevant READMEs (local and/or global)
  • Update any relevant global documentation & references

Testing Methodology

  • Add: Example of how p1 works
  • All tests: make test_all
  • LocalNet: verify a LocalNet is still functioning correctly by following the instructions at docs/development/README.md

Creator: @deblasis
Co-Owners: @Olshansk

Metadata

Metadata

Labels

clientwork needed to interface with the node (rpc, cli, etc..)

Type

No type

Projects

Status

Done

Relationships

None yet

Development

No branches or pull requests

Issue actions