Neck Protection Mandate

    solarium-cli
    TypeScript icon, indicating that this package has built-in type declarations

    0.1.11 • Public • Published

    solarium-cli

    CLI for Solarium: The E2E-encrypted messenger on Solana

    oclif Version Downloads/week License

    Usage

    $ npm install -g solarium-cli
    $ solarium COMMAND
    running command...
    $ solarium (-v|--version|version)
    solarium-cli/0.1.11 darwin-x64 node-v16.0.0
    $ solarium --help [COMMAND]
    USAGE
      $ solarium COMMAND
    ...

    Commands

    solarium add-key [PUBLICKEY]

    Add a new key to an existing DID

    USAGE
      $ solarium add-key [PUBLICKEY]
    
    ARGUMENTS
      PUBLICKEY  A public key in base-58 encoding
    
    OPTIONS
      -h, --help       show CLI help
      -n, --name=name  (required) the key name (e.g. mobileDevice)
    

    See code: src/commands/add-key.ts

    solarium chat WITH

    Chat with another DID. Note: the DID must already exist.

    USAGE
      $ solarium chat WITH
    
    ARGUMENTS
      WITH  The DID to chat with
    
    OPTIONS
      -h, --help  show CLI help
      -m, --mute  non-verbose input
    
    ALIASES
      $ solarium
    

    See code: src/commands/chat.ts

    solarium create NAME

    Create a channel

    USAGE
      $ solarium create NAME
    
    OPTIONS
      -h, --help  show CLI help
    

    See code: src/commands/create.ts

    solarium help [COMMAND]

    display help for solarium

    USAGE
      $ solarium help [COMMAND]
    
    ARGUMENTS
      COMMAND  command to show help for
    
    OPTIONS
      --all  see all commands in CLI
    

    See code: @oclif/plugin-help

    solarium id

    Show or create an identity

    USAGE
      $ solarium id
    
    OPTIONS
      -c, --create   Create a DID if missing
      -h, --help     show CLI help
      -v, --verbose  Show the entire DID document
    

    See code: src/commands/id.ts

    solarium invite [INVITEE] [CHANNEL]

    Invite someone to a group channel

    USAGE
      $ solarium invite [INVITEE] [CHANNEL]
    
    ARGUMENTS
      INVITEE  The invitee DID
      CHANNEL  The channel address
    
    OPTIONS
      -h, --help  show CLI help
    
    EXAMPLE
      solarium invite did:sol:<INVITEE> <CHANNEL_ADDRESS>
    

    See code: src/commands/invite.ts

    solarium post [MESSAGE]

    Post to a channel

    USAGE
      $ solarium post [MESSAGE]
    
    OPTIONS
      -c, --channel=channel  (required) Channel address
      -h, --help             show CLI help
      -i, --from-stdin
    

    See code: src/commands/post.ts

    solarium read [CHANNEL]

    Read a channel

    USAGE
      $ solarium read [CHANNEL]
    
    OPTIONS
      -h, --help  show CLI help
    
    ALIASES
      $ solarium get
    

    See code: src/commands/read.ts

    solarium watch [CHANNEL]

    Listen to new messages from a channel

    USAGE
      $ solarium watch [CHANNEL]
    
    OPTIONS
      -h, --help  show CLI help
    

    See code: src/commands/watch.ts

    Keywords

    Install

    npm i solarium-cli

    DownloadsWeekly Downloads

    1

    Version

    0.1.11

    License

    MIT

    Unpacked Size

    29.8 kB

    Total Files

    50

    Last publish

    Collaborators

    • dankelleher