Joystream / community-repo

A repo for community contribution and documentation
GNU General Public License v3.0
19 stars 73 forks source link

Status Check - `joystream-cli` #781

Closed bwhm closed 1 year ago

bwhm commented 2 years ago

Go through all commands in the joystream-cli

Story points:

Existing Commands

If a transaction:

Needed Commands (transactions)

Compare the transactions supported by the cli, to all the transaction for said module. For all transactions missing:

Compare the modules with some transaction support to those without.

Deliverable

For each module with at least one transaction supported, produce a table that list all available transactions (eg. balances.Transfer), and if supported, the corresponding cli command (eg. account:transferTokens). Include the answers to the questions above in the table where applicable, and add context where needed.

For each module without any transactions supported, but you think "should be" (partially or not), list the transactions that you think should be supported, and answer the questions above.

OPTIONAL

Needed Commands (non-transactions)

Finally, are there any non-transaction commands that would be useful for some working group or users, that the cli doesn't support, and isn't available elsewhere. Ask the Leads for each group, and potentially some users that have a particular interest in one module, and:

Optional Deliverable

List the "wanted" non-transaction commands, and answer the question above.

traumschule commented 2 years ago

created a structure: https://github.com/traumschule/joystream/blob/cli-commands/cli/doc/Commands.md To add info just create a PR to the branch and i'll merge it!

@singulart i suggest to assign a worker to help fill the tables and communicate to leads, not sure when i get to it.

oleksanderkorn commented 2 years ago

@bwhm I finished with the status check, all the CLI commands were checked and are working as expected. The results are in the table, based on the structure provided by @traumschule