Skip to content

Commit

Permalink
Update soroban-cli-full-docs.md
Browse files Browse the repository at this point in the history
  • Loading branch information
leighmcculloch authored May 2, 2024
1 parent d15db7c commit 72ab2b7
Showing 1 changed file with 38 additions and 29 deletions.
67 changes: 38 additions & 29 deletions docs/soroban-cli-full-docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,10 +52,11 @@ This document contains the help content for the `soroban` command-line program.
* [`soroban network stop`](#soroban-network-stop)
* [`soroban version`](#soroban-version)
* [`soroban cache`](#soroban-cache)
* [`soroban cache ls`](#soroban-cache-ls)
* [`soroban cache info`](#soroban-cache-info)
* [`soroban cache clean`](#soroban-cache-clean)
* [`soroban cache read`](#soroban-cache-read)
* [`soroban cache path`](#soroban-cache-path)
* [`soroban cache actionlog`](#soroban-cache-actionlog)
* [`soroban cache actionlog ls`](#soroban-cache-actionlog-ls)
* [`soroban cache actionlog read`](#soroban-cache-actionlog-read)

## `soroban`

Expand Down Expand Up @@ -1273,63 +1274,71 @@ Cache for tranasctions and contract specs

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

* `ls` — List cached actions (transactions, simulations)
* `info` — Show location of cache
* `clean` — Delete all cached actions
* `read` — Read cached action
* `clean` — Delete the cache
* `path` — Show the location of the cache
* `actionlog` — Access details about cached actions like transactions, and simulations. (Experimental. May see breaking changes at any time.)



## `soroban cache ls`
## `soroban cache clean`

List cached actions (transactions, simulations)
Delete the cache

**Usage:** `soroban cache ls [OPTIONS]`
**Usage:** `soroban cache clean`

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

* `--global` — Use global config

Possible values: `true`, `false`
## `soroban cache path`

* `--config-dir <CONFIG_DIR>` — Location of config directory, default is "."
* `-l`, `--long`
Show the location of the cache

Possible values: `true`, `false`
**Usage:** `soroban cache path`



## `soroban cache actionlog`

## `soroban cache info`
Access details about cached actions like transactions, and simulations. (Experimental. May see breaking changes at any time.)

Show location of cache
**Usage:** `soroban cache actionlog <COMMAND>`

**Usage:** `soroban cache info`
###### **Subcommands:**

* `ls` — List cached actions (transactions, simulations)
* `read` — Read cached action


## `soroban cache clean`

Delete all cached actions
## `soroban cache actionlog ls`

**Usage:** `soroban cache clean`
List cached actions (transactions, simulations)

**Usage:** `soroban cache actionlog ls [OPTIONS]`

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

## `soroban cache read`
* `--global` — Use global config

Read cached action
Possible values: `true`, `false`

**Usage:** `soroban cache read [OPTIONS] --id <ID>`
* `--config-dir <CONFIG_DIR>` — Location of config directory, default is "."
* `-l`, `--long`

###### **Options:**
Possible values: `true`, `false`

* `--id <ID>` — ULID of the cache entry
* `--output <OUTPUT>`

Possible values: `envelope`


## `soroban cache actionlog read`

Read cached action

**Usage:** `soroban cache actionlog read --id <ID>`

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

* `--id <ID>` — ID of the cache entry



<hr/>
Expand Down

0 comments on commit 72ab2b7

Please sign in to comment.