Crate ockam_command

This crate provides the ockam command line application to:

• start Ockam nodes and interact with them
• manage projects and spaces hosted within the Ockam Orchestrator

For more information please visit the command guide

Instructions on how to install Ockam Command

1. You can install Ockam Command pre-built binary using these steps. You can run the following command in your terminal to install the pre-built binary:

   curl --proto '=https' --tlsv1.2 -sSfL https://install.command.ockam.io | bash
   

2. To build Ockam Command from source, fork the repo, and then clone it to your machine. Open a terminal and go to the folder that you just cloned the repo into. Then run the following to install ockam so that you can run it from the command line.

   cd implementations/rust/ockam/ockam_command && cargo install --path .
   

Re-exports

• pub use error::*;
• pub use pager::*;

Modules

• colors
• enroll
• entry_point
• error
• fmt
• identity
• mode
  The possible states of Terminal. Each state defines what methods can be used on a given instance.
• node
• pager
• shutdown
• tcp
• term
  Implementation of the TerminalWriter using the Term crate
• tui
• util
• value_parsers

Macros

• color
• fmt_err
• fmt_heading
• fmt_info
• fmt_list
• fmt_log
• fmt_ok
• fmt_para
• fmt_warn

Structs

• CommandGlobalOpts
  This struct contains the main structs used to implement commands:
• GlobalArgs
  Those arguments are common to all commands
• OckamCommand
  Top-level command, with:
• Output
  The command’s output message to be displayed to the user in various formats
• Terminal
  A terminal abstraction to handle commands’ output and messages styling.
• TerminalStream
  A small wrapper around the Write trait, enriched with CLI attributes to facilitate output handling.

Enums

• ConfirmResult
• OckamColor
• OckamSubcommand
  List of commands which can be executed with ockam
• PluralTerm
• TerminalBackground

Traits

• Command
• TerminalWriter
  Trait defining the main methods to write messages to a terminal stream.

Functions

• add_command_error_event
  This function creates a journey event describing the error resulting from the execution of a command
• add_command_event
  This function creates a journey event describing the execution of a command
• color_email
• color_primary
• color_primary_alt
• color_uri
• has_help_flag
  Return true if the list of arguments contains a help flag
• has_version_flag
  Return true if the list of arguments contains a version flag
• replace_hyphen_with_stdin
  Replaces the ‘-’ placeholder character with a string value coming from stdin This is useful to be able to pipe the output of a command to another command.