# gizfs:cli

The storage command group, `giz storage OPERATION ...`: one table of storage operations over the typed Client of volume.giz. The command line, its help and the Operation registry read the table. A local range and gizstack.com differ only in GIZ_STORAGE_NODES (the endpoint list of protocol.giz) and GIZ_STORAGE_CREDENTIAL (an issued credential: fs/issue.giz or `key create`).

```gizlang
import * as Cli from "gizfs:cli";
```

## Types

### `Command`

```gizlang
type Command = { name: string; operands: string; risk: string; summary: string; }
```

One storage operation: its words after `storage`, operands, risk class
(read, write, execute or destructive) and help text.

- `name`: `string`
- `operands`: `string`
- `risk`: `string`
- `summary`: `string`

## Functions

### `operations`

```gizlang
function operations(): Vec<Command>
```

Every operation, in the order that help lists them.

Effects: fail.

### `run`

```gizlang
function run(sys: System, given: Vec<string>): i64
```

Run `storage ARGS`. Exit status 0 on success, 1 on a failed operation, 2 on a wrong command line.

Effects: fail, read, write, console, io.

gizfs:cli

The storage command group, giz storage OPERATION ...: one table of storage operations over the typed Client of volume.giz. The command line, its help and the Operation registry read the table. A local range and gizstack.com differ only in GIZ_STORAGE_NODES (the endpoint list of protocol.giz) and GIZ_STORAGE_CREDENTIAL (an issued credential: fs/issue.giz or key create).

gizlang

import * as Cli from "gizfs:cli";

Types

`Command`

gizlang

type Command = { name: string; operands: string; risk: string; summary: string; }

One storage operation: its words after storage, operands, risk class (read, write, execute or destructive) and help text.

name: string
operands: string
risk: string
summary: string

Functions

`operations`

gizlang

function operations(): Vec<Command>

Every operation, in the order that help lists them.

Effects: fail.

`run`

gizlang

function run(sys: System, given: Vec<string>): i64

Run storage ARGS. Exit status 0 on success, 1 on a failed operation, 2 on a wrong command line.

Effects: fail, read, write, console, io.