Crate ockam_command
source ·Expand description
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
-
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
-
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§
Modules§
- The possible states of Terminal. Each state defines what methods can be used on a given instance.
- Implementation of the
TerminalWriter
using theTerm
crate
Macros§
Structs§
- This struct contains the main structs used to implement commands:
- Those arguments are common to all commands
- Top-level command, with:
- The command’s output message to be displayed to the user in various formats
- A terminal abstraction to handle commands’ output and messages styling.
- A small wrapper around the
Write
trait, enriched with CLI attributes to facilitate output handling.
Enums§
- List of commands which can be executed with
ockam
Traits§
- Trait defining the main methods to write messages to a terminal stream.
Functions§
- This function creates a journey event describing the error resulting from the execution of a command
- This function creates a journey event describing the execution of a command
- Return true if the list of arguments contains a help flag
- Return true if the list of arguments contains a version flag
- 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.