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 Command Design: Create a Trust Claim (subcommand: claim) #6

Open
harlantwood opened this issue Oct 29, 2022 · 5 comments
Open

CLI Command Design: Create a Trust Claim (subcommand: claim) #6

harlantwood opened this issue Oct 29, 2022 · 5 comments
Assignees

Comments

@harlantwood
Copy link
Member

harlantwood commented Oct 29, 2022

Usage

Create Claims

trust claim --help

Usage: trust-claim [options]

  Options:

    -h, --help                   output usage information
    --creator <creator>          DID or URL of claim creator
    --target <target>            DID or URL of claim target
    --tags <tag1, tag2>          Rating tags (at least 1 tag is required)
    --description <description>  Rating description
    --extra key=value           Extra data (can be used multiple times)
    --value <value>              Rating weight in the range 0..1
    --algorithm <algorithm>      Signing algorithm
    --private-key <key>          Private key
    --target-format <format>     opentrustclaim | reputon | trustatom | trustclaim 
    --write <store>              stdout | file | ipfs 

Note: add OpenTrustClaim fields as top level --options.

* reputons: https://www.rfc-editor.org/rfc/rfc7071

@harlantwood harlantwood changed the title CLI Design CLI command design Oct 29, 2022
@ocarissa ocarissa changed the title CLI command design CLI Command Design: Create a Trust Claim (subcommand: claim) Nov 3, 2022
@ocarissa
Copy link

ocarissa commented Nov 3, 2022

@dauphin3
Copy link
Collaborator

should all these args/flags be required? for now I have description and value as optional

@harlantwood
Copy link
Member Author

Target is the only one that is required. The others are optional, some are not needed, like extra, and others have smart defaults.
@dauphin3

@dauphin3
Copy link
Collaborator

this command is meant to return a JSON-LD as a type serde_json::Value
is that correct?

@harlantwood
Copy link
Member Author

If
--target-format trustatom
And
--write stdout
Then just a JSON string, canonicalized (keys sorted) and minified.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants