Skip to content

Commit

Permalink
docs: update scli
Browse files Browse the repository at this point in the history
  • Loading branch information
gluax committed May 12, 2024
1 parent 1a41590 commit 6361a33
Showing 1 changed file with 45 additions and 2 deletions.
47 changes: 45 additions & 2 deletions snops_book/user_guide/clis/SNOPS_CLI.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ This document contains the help content for the `snops-cli` command-line program
* [`snops-cli`](#snops-cli)
* [`snops-cli autocomplete`](#snops-cli-autocomplete)
* [`snops-cli agent`](#snops-cli-agent)
* [`snops-cli agent find`](#snops-cli-agent-find)
* [`snops-cli agent info`](#snops-cli-agent-info)
* [`snops-cli agent list`](#snops-cli-agent-list)
* [`snops-cli agent tps`](#snops-cli-agent-tps)
Expand Down Expand Up @@ -72,6 +73,7 @@ For interacting with snop agents

###### **Subcommands:**

* `find` — Find agents by set criteria. If all of client/compute/prover/validator are not specified it can be any one of them
* `info` — Get the specific agent
* `list` — List all agents. Ignores the agent id
* `tps` — Get the specific agent's TPS
Expand All @@ -84,6 +86,47 @@ For interacting with snop agents



## `snops-cli agent find`

Find agents by set criteria. If all of client/compute/prover/validator are not specified it can be any one of them

**Usage:** `snops-cli agent find [OPTIONS]`

###### **Options:**

* `--client` — Whether the agent can be a client

Possible values: `true`, `false`

* `--compute` — Whether the agent can be a compute

Possible values: `true`, `false`

* `--prover` — Whether the agent can be a prover

Possible values: `true`, `false`

* `--validator` — Whether the agent can be a validator

Possible values: `true`, `false`

* `--env <ENV>` — Which env you are finding the agens from. Not specifing a env, means only inventoried agents are found
* `--all` — Means regardless of connection status, and state we find them

Possible values: `true`, `false`

* `--labels <LABELS>` — The labels an agent should have
* `--local-pk` — If the agent has a local private key or not

Possible values: `true`, `false`

* `--include-offline` — Wether to include offline agents as well

Possible values: `true`, `false`




## `snops-cli agent info`

Get the specific agent
Expand Down Expand Up @@ -179,7 +222,7 @@ List all steps for a specific timeline
###### **Subcommands:**

* `apply` — Apply a timeline to an environment
* `delete` — Delete a timeline from an environment.zs
* `delete` — Delete a timeline from an environment
* `info` — List all steps for a specific timeline
* `list` — List all timelines for a specific environment. Timeline id is ignored
* `start` — Start an environment's timeline (a test)
Expand All @@ -203,7 +246,7 @@ Apply a timeline to an environment

## `snops-cli env timeline delete`

Delete a timeline from an environment.zs
Delete a timeline from an environment

**Usage:** `snops-cli env timeline delete`

Expand Down

0 comments on commit 6361a33

Please sign in to comment.