Developers
Tangle Blueprint CLI
Reference

Tangle CLI Reference

Blueprint

The primary subcommand, used for building, testing, and deploying blueprints.

  • Aliases: bp

Usage:

$ cargo tangle blueprint <subcommand>

Subcommands

Note that unless specified, all arguments are optional.

Create

Creates a new blueprint

  • Name: create
  • Aliases: c
  • Options:
    • --name (required): The name of the blueprint
    • --repo: The repo to pull the template from, by default this uses the hello world blueprint template (opens in a new tab)
    • --path: The path to copy a template from, no default value

Usage:

Create a blueprint using the default template

$ cargo tangle blueprint create --name <name>

Create a blueprint using another template from git

$ cargo tangle blueprint create --name <name> --repo <git-repo-url>

Deploy

Deploy a blueprint to Tangle

  • Name: deploy
  • Aliases: d
  • Options:
    • rpc-url: The tangle RPC URL to use (default: wss://rpc.tangle.tools)
    • package: The package to deploy, useful when using workspaces
  • Environment Variables:
    • SIGNER (required): The SURI of the Subtrate signer account
    • EVM_SIGNER (required): The SURI of the EVM signer account

Usage:

Deploy a blueprint to a local Tangle node:

export SIGNER="//Alice"
export EVM_SIGNER="0xcb6df9de1efca7a3998a8ead4e02159d5fa99c3e0d4fd6432667390bb4726854"
cargo tangle blueprint deploy --rpc-url <rpc-url>

Where <rpc-url> will likely be ws://localhost:9944.

Generate Keys

  • Name: generate-keys
  • Options:
    • key-type (alias: k) (required): The key type to generate (sr25519, ecdsa, bls_bn254, ed25519, bls381)
    • path (alias: p): The path to write the generated keypair to. If not provided, the keypair will be written solely to stdout
    • seed (alias: s): The SURI/seed to generate the keypair from. If not provided, a random keypair will be generated
    • show-secret: Denotes that the Private Key should also be printed to stdout. If not provided, only the public key will be printed