Nitrogenous Polymorphic Molecule

    @identity.com/cryptid-cli
    TypeScript icon, indicating that this package has built-in type declarations

    0.1.11 • Public • Published

    @identity.com/cryptid-cli

    Sign transactions and configure Cryptid DID Wallets

    oclif Version Downloads/week License

    Usage

    $ npm install -g @identity.com/cryptid-cli
    $ cryptid COMMAND
    running command...
    $ cryptid (--version|-v)
    @identity.com/cryptid-cli/0.1.11 darwin-arm64 node-v16.13.0
    $ cryptid --help [COMMAND]
    USAGE
      $ cryptid COMMAND
    ...

    Commands

    cryptid address

    Show the cryptid account's address

    USAGE
      $ cryptid address [-h] [-c <value>] [-s <value>]
    
    FLAGS
      -c, --config=<value>  Path to config file
      -h, --help            Show CLI help.
      -s, --as=<value>      Execute transactions as a controlled identity (alias or did)
    
    DESCRIPTION
      Show the cryptid account's address
    

    See code: src/commands/address.ts

    cryptid airdrop [AMOUNT]

    Airdrop funds into the cryptid account and owner key

    USAGE
      $ cryptid airdrop [AMOUNT] [-h] [-c <value>] [-s <value>]
    
    FLAGS
      -c, --config=<value>  Path to config file
      -h, --help            Show CLI help.
      -s, --as=<value>      Execute transactions as a controlled identity (alias or did)
    
    DESCRIPTION
      Airdrop funds into the cryptid account and owner key
    

    See code: src/commands/airdrop.ts

    cryptid alias [NAME] [DID]

    Associate a DID with an alias

    USAGE
      $ cryptid alias [NAME] [DID] [-h] [-c <value>] [-s <value>] [-u]
    
    FLAGS
      -c, --config=<value>  Path to config file
      -h, --help            Show CLI help.
      -s, --as=<value>      Execute transactions as a controlled identity (alias or did)
      -u, --unset           unset an alias
    
    DESCRIPTION
      Associate a DID with an alias
    

    See code: src/commands/alias.ts

    cryptid balance

    Show the cryptid account SOL balance

    USAGE
      $ cryptid balance [-h] [-c <value>] [-s <value>]
    
    FLAGS
      -c, --config=<value>  Path to config file
      -h, --help            Show CLI help.
      -s, --as=<value>      Execute transactions as a controlled identity (alias or did)
    
    DESCRIPTION
      Show the cryptid account SOL balance
    

    See code: src/commands/balance.ts

    cryptid base

    USAGE
      $ cryptid base [-h] [-c <value>] [-s <value>]
    
    FLAGS
      -c, --config=<value>  Path to config file
      -h, --help            Show CLI help.
      -s, --as=<value>      Execute transactions as a controlled identity (alias or did)
    

    See code: src/commands/base.ts

    cryptid config [SUBCOMMAND] [KEY] [VALUE]

    Manage Cryptid configuration

    USAGE
      $ cryptid config [SUBCOMMAND] [KEY] [VALUE] [-h] [-c <value>] [-s <value>]
    
    FLAGS
      -c, --config=<value>  Path to config file
      -h, --help            Show CLI help.
      -s, --as=<value>      Execute transactions as a controlled identity (alias or did)
    
    DESCRIPTION
      Manage Cryptid configuration
    

    See code: src/commands/config.ts

    cryptid controller add [DID]

    Add a controller to a cryptid account

    USAGE
      $ cryptid controller add [DID] [-h] [-c <value>] [-s <value>]
    
    FLAGS
      -c, --config=<value>  Path to config file
      -h, --help            Show CLI help.
      -s, --as=<value>      Execute transactions as a controlled identity (alias or did)
    
    DESCRIPTION
      Add a controller to a cryptid account
    

    cryptid controller remove [DID]

    Remove a controller from a cryptid account

    USAGE
      $ cryptid controller remove [DID] [-h] [-c <value>] [-s <value>]
    
    FLAGS
      -c, --config=<value>  Path to config file
      -h, --help            Show CLI help.
      -s, --as=<value>      Execute transactions as a controlled identity (alias or did)
    
    DESCRIPTION
      Remove a controller from a cryptid account
    

    cryptid controller show [DID]

    Show the controllers of a cryptid account

    USAGE
      $ cryptid controller show [DID] [-h] [-c <value>] [-s <value>]
    
    FLAGS
      -c, --config=<value>  Path to config file
      -h, --help            Show CLI help.
      -s, --as=<value>      Execute transactions as a controlled identity (alias or did)
    
    DESCRIPTION
      Show the controllers of a cryptid account
    

    cryptid document

    Show the cryptid account's DID Document

    USAGE
      $ cryptid document [-h] [-c <value>] [-s <value>]
    
    FLAGS
      -c, --config=<value>  Path to config file
      -h, --help            Show CLI help.
      -s, --as=<value>      Execute transactions as a controlled identity (alias or did)
    
    DESCRIPTION
      Show the cryptid account's DID Document
    

    See code: src/commands/document.ts

    cryptid help [COMMAND]

    Display help for cryptid.

    USAGE
      $ cryptid help [COMMAND] [-n]
    
    ARGUMENTS
      COMMAND  Command to show help for.
    
    FLAGS
      -n, --nested-commands  Include all nested commands in the output.
    
    DESCRIPTION
      Display help for cryptid.
    

    See code: @oclif/plugin-help

    cryptid init

    Initialise the cryptid library

    USAGE
      $ cryptid init [-h] [-o] [-p <value>] [-k <value>] [-z <value>]
    
    FLAGS
      -h, --help             Show CLI help.
      -k, --key=<value>      Path to a solana keypair
      -o, --overwrite        Overwrite existing configuration
      -p, --path=<value>     Configuration path
      -z, --cluster=<value>  Cluster
    
    DESCRIPTION
      Initialise the cryptid library
    

    See code: src/commands/init.ts

    cryptid key add [KEY] [ALIAS]

    Add a cryptid key

    USAGE
      $ cryptid key add [KEY] [ALIAS] [-h] [-c <value>] [-s <value>]
    
    FLAGS
      -c, --config=<value>  Path to config file
      -h, --help            Show CLI help.
      -s, --as=<value>      Execute transactions as a controlled identity (alias or did)
    
    DESCRIPTION
      Add a cryptid key
    

    cryptid key remove [ALIAS]

    Remove a cryptid key

    USAGE
      $ cryptid key remove [ALIAS] [-h] [-c <value>] [-s <value>]
    
    FLAGS
      -c, --config=<value>  Path to config file
      -h, --help            Show CLI help.
      -s, --as=<value>      Execute transactions as a controlled identity (alias or did)
    
    DESCRIPTION
      Remove a cryptid key
    

    cryptid key show

    List keys attached to the cryptid account

    USAGE
      $ cryptid key show [-h] [-c <value>] [-s <value>]
    
    FLAGS
      -c, --config=<value>  Path to config file
      -h, --help            Show CLI help.
      -s, --as=<value>      Execute transactions as a controlled identity (alias or did)
    
    DESCRIPTION
      List keys attached to the cryptid account
    
    ALIASES
      $ cryptid
    

    cryptid plugins

    List installed plugins.

    USAGE
      $ cryptid plugins [--core]
    
    FLAGS
      --core  Show core plugins.
    
    DESCRIPTION
      List installed plugins.
    
    EXAMPLES
      $ cryptid plugins
    

    See code: @oclif/plugin-plugins

    cryptid plugins:inspect PLUGIN...

    Displays installation properties of a plugin.

    USAGE
      $ cryptid plugins:inspect PLUGIN...
    
    ARGUMENTS
      PLUGIN  [default: .] Plugin to inspect.
    
    FLAGS
      -h, --help     Show CLI help.
      -v, --verbose
    
    DESCRIPTION
      Displays installation properties of a plugin.
    
    EXAMPLES
      $ cryptid plugins:inspect myplugin
    

    cryptid plugins:install PLUGIN...

    Installs a plugin into the CLI.

    USAGE
      $ cryptid plugins:install PLUGIN...
    
    ARGUMENTS
      PLUGIN  Plugin to install.
    
    FLAGS
      -f, --force    Run yarn install with force flag.
      -h, --help     Show CLI help.
      -v, --verbose
    
    DESCRIPTION
      Installs a plugin into the CLI.
    
      Can be installed from npm or a git url.
    
      Installation of a user-installed plugin will override a core plugin.
    
      e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
      will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
      the CLI without the need to patch and update the whole CLI.
    
    ALIASES
      $ cryptid plugins add
    
    EXAMPLES
      $ cryptid plugins:install myplugin 
    
      $ cryptid plugins:install https://github.com/someuser/someplugin
    
      $ cryptid plugins:install someuser/someplugin
    

    cryptid plugins:link PLUGIN

    Links a plugin into the CLI for development.

    USAGE
      $ cryptid plugins:link PLUGIN
    
    ARGUMENTS
      PATH  [default: .] path to plugin
    
    FLAGS
      -h, --help     Show CLI help.
      -v, --verbose
    
    DESCRIPTION
      Links a plugin into the CLI for development.
    
      Installation of a linked plugin will override a user-installed or core plugin.
    
      e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
      command will override the user-installed or core plugin implementation. This is useful for development work.
    
    EXAMPLES
      $ cryptid plugins:link myplugin
    

    cryptid plugins:uninstall PLUGIN...

    Removes a plugin from the CLI.

    USAGE
      $ cryptid plugins:uninstall PLUGIN...
    
    ARGUMENTS
      PLUGIN  plugin to uninstall
    
    FLAGS
      -h, --help     Show CLI help.
      -v, --verbose
    
    DESCRIPTION
      Removes a plugin from the CLI.
    
    ALIASES
      $ cryptid plugins unlink
      $ cryptid plugins remove
    

    cryptid plugins update

    Update installed plugins.

    USAGE
      $ cryptid plugins update [-h] [-v]
    
    FLAGS
      -h, --help     Show CLI help.
      -v, --verbose
    
    DESCRIPTION
      Update installed plugins.
    

    cryptid token balance MINT

    show an SPL Token balance

    USAGE
      $ cryptid token balance [MINT] [-h] [-c <value>] [-s <value>]
    
    ARGUMENTS
      MINT  The SPL-Token mint(base58)
    
    FLAGS
      -c, --config=<value>  Path to config file
      -h, --help            Show CLI help.
      -s, --as=<value>      Execute transactions as a controlled identity (alias or did)
    
    DESCRIPTION
      show an SPL Token balance
    

    cryptid token show

    show all SPL Token balances

    USAGE
      $ cryptid token show [-h] [-c <value>] [-s <value>]
    
    FLAGS
      -c, --config=<value>  Path to config file
      -h, --help            Show CLI help.
      -s, --as=<value>      Execute transactions as a controlled identity (alias or did)
    
    DESCRIPTION
      show all SPL Token balances
    

    cryptid token transfer TO AMOUNT

    Send SPL-Tokens to a recipient

    USAGE
      $ cryptid token transfer [TO] [AMOUNT] -m <value> [-h] [-c <value>] [-s <value>] [-f]
    
    ARGUMENTS
      TO      Recipient alias, did or public key (base58)
      AMOUNT  The amount in lamports to transfer
    
    FLAGS
      -c, --config=<value>          Path to config file
      -f, --allowUnfundedRecipient  Create a token account for the recipient if needed
      -h, --help                    Show CLI help.
      -m, --mint=<value>            (required) The SPL-Token mint(base58)
      -s, --as=<value>              Execute transactions as a controlled identity (alias or did)
    
    DESCRIPTION
      Send SPL-Tokens to a recipient
    

    cryptid transfer TO AMOUNT

    Send SOL to a recipient

    USAGE
      $ cryptid transfer [TO] [AMOUNT] [-h] [-c <value>] [-s <value>]
    
    ARGUMENTS
      TO      Recipient alias, did or public key (base58)
      AMOUNT  The amount in lamports to transfer
    
    FLAGS
      -c, --config=<value>  Path to config file
      -h, --help            Show CLI help.
      -s, --as=<value>      Execute transactions as a controlled identity (alias or did)
    
    DESCRIPTION
      Send SOL to a recipient
    

    See code: src/commands/transfer.ts

    cryptid version

    USAGE
      $ cryptid version
    

    See code: @oclif/plugin-version

    Keywords

    Install

    npm i @identity.com/cryptid-cli

    DownloadsWeekly Downloads

    1

    Version

    0.1.11

    License

    MIT

    Unpacked Size

    96.2 kB

    Total Files

    87

    Last publish

    Collaborators

    • diosakhilleus
    • chriteixeira
    • rado0x54
    • araptarchis
    • mitchcivic
    • identity.com-ci
    • dankelleher
    • flippiescholtz
    • kevinhcolgan
    • pbshoemaker
    • tyronemichael
    • lucmir
    • william-identity