Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CLI refactor #266

Open
clehner opened this issue Mar 1, 2022 · 0 comments
Open

CLI refactor #266

clehner opened this issue Mar 1, 2022 · 0 comments
Labels
developer experience Make nicer and easier to use for developers

Comments

@clehner
Copy link
Contributor

clehner commented Mar 1, 2022

In #259 a key subcommand was added with generate as a sub-subcommand (e.g. didkit key generate ed25519). Would it be useful to similarly group other commands?

Existing subcommands for DID-related functionality:

  • did-auth (generate DIDAuth VP)
  • did-resolve (DID -> DID document)
  • did-dereference (DID URL -> data)
  • key-to-did (JWK -> DID)
  • key-to-verification-method (JWK -> DID URL)

Subcommands proposed in #255:

  • did-create
  • did-update
    • set-verification-method
    • set-service
    • remove-service
    • remove-verification-method
  • did-recover
  • did-deactivate
  • did-from-tx
  • did-submit-tx

The above proposed DID operation subcommands don't directly perform the operation (at least for did:ion) but instead return an object ("DID method transaction") which then must be passed to either the did-submit subcommand to submit it, or to the did-from-tx subcommand to derive/extract a DID from it. Maybe these operation commands should be under a operation subcommand?
Like how the the ION CLI (https://github.com/decentralized-identity/ion/blob/d644bc78b199adc07a6ade8a0774408cfb564619/cli.md#create-operation) has ion operation <create|update|recover|deactivate> [options] (although it only implements create currently).

Subcommands for VC API:

  • vc-issue-credential
  • vc-issue-presentation (maybe should be renamed to prove-credential, present-credential, or create-presentation, rather than impliying that presentations are issued)
  • vc-verify-credential
  • vc-verify-presentation

Other miscellaneous commands:

  • help (built-in)
  • ssh-pk-to-jwk (could be under key?)
  • to-rdf-urdna2015 (could be under jsonld or ld?)

Other CLIs to consider for inspiration and/or alignment:

@clehner clehner mentioned this issue Mar 1, 2022
8 tasks
@clehner clehner added the developer experience Make nicer and easier to use for developers label Apr 12, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
developer experience Make nicer and easier to use for developers
Projects
None yet
Development

No branches or pull requests

1 participant