% SPLINTER-CIRCUIT-PROPOSALS(1) Cargill, Incorporated | Splinter Commands

NAME

splinter-circuit-proposals — Lists the current circuit proposals

SYNOPSIS

splinter circuit proposals [FLAGS] [OPTIONS]

DESCRIPTION

Lists all of the circuit proposals that the local node is a proposed member of. This command displays abbreviated information pertaining to proposed circuits in columns, with the headers ID, NAME, MANAGEMENT, MEMBERS, COMMENTS, and PROPOSAL_TYPE. This makes it possible to verify that circuit proposals have been successfully proposed as well as being able to access the generated circuit ID assigned to a proposal. This also makes it possible to verify the intention of the circuit proposal. Circuit proposals have not necessarily been voted on by all proposed members.

FLAGS

-h, --help: Prints help information
-q, --quiet: Decrease verbosity (the opposite of -v). When specified, only errors or warnings will be output.
-V, --version: Prints version information
-v: Increases verbosity (the opposite of -q). Specify multiple times for more output.

OPTIONS

-F, --format FORMAT: Specifies the output format of the circuit proposal. (default human). Possible values for formatting are human and csv. The human option displays the circuit proposals information in a formatted table, while csv prints the circuit proposals information via comma-separated values.
-k, --key PRIVATE-KEY-FILE: Specifies the private signing key (either a file path or the name of a .priv file in $HOME/.splinter/keys).
--management-type MANAGEMENT-TYPE: Filter the circuit proposals by their circuit management type.
-m, --member MEMBER: Filter the circuits list by a node ID that is present in the circuit proposal’s members list.
-U, --url URL: Specifies the URL for the splinterd REST API. The URL is required unless $SPLINTER_REST_API_URL is set.

EXAMPLES

This command displays information about circuit proposals with a default human formatting, meaning the information is displayed in a table. The --member and --management-type options allow for filtering the circuit proposals.

The following command does not specify any filters, therefore all circuit proposals the local node, node-000 is a part of are displayed.

$ splinter circuit proposals \
  --url URL-of-node-000-splinterd-REST-API
ID           NAME      MANAGEMENT    MEMBERS            COMMENTS  PROPOSAL_TYPE
01234-ABCDE  -         mgmt001       node-000;node-001  -         Create
43210-ABCDE  circuit1  mgmt001       node-000;node-002  -         Create
56789-ABCDE  -         mgmt002       node-000;node-002  -         Create

The next command specifies a --management-type filter, therefore all circuit proposals the local node, node-000 is a part of with a circuit_management_type of mgmt001 will be listed.

$ splinter circuit proposals \
  --management-type mgmt001 \
  --url URL-of-node-000-splinterd-REST-API
ID           NAME      MANAGEMENT    MEMBERS            COMMENTS  PROPOSAL_TYPE
01234-ABCDE  -         mgmt001       node-000;node-001  -         Create
43210-ABCDE  circuit1  mgmt001       node-000;node-002  -         Create

The next command specifies a --member filter, therefore all circuit proposals the local node, node-000 is a part of including the node-002 node ID will be listed.

$ splinter circuit proposals \
  member node-002 \
  --url URL-of-node-000-splinterd-REST-API
ID            NAME      MANAGEMENT    MEMBERS            COMMENTS  PROPOSAL_TYPE
43210-ABCDE   circuit1  mgmt001       node-000;node-002  -         Create
56789-ABCDE   -         mgmt002       node-000;node-002  -         Create

The next command does not specify any filters, therefore all circuit proposals the local node, node-000 is a part of are displayed. This includes a circuit proposal to disband an existing circuit, 01234-FGHIJ.

$ splinter circuit proposals \
  --url URL-of-node-000-splinterd-REST-API
ID           NAME      MANAGEMENT    MEMBERS            COMMENTS  PROPOSAL_TYPE
01234-ABCDE  -         mgmt001       node-000;node-001  -         Create
43210-ABCDE  circuit1  mgmt001       node-000;node-002  -         Create
56789-ABCDE  -         mgmt002       node-000;node-002  -         Create
01234-FGHIJ  circuit0  mgmt002       node-000;node-002  -         Disband

ENVIRONMENT VARIABLES

SPLINTER_REST_API_URL: URL for the splinterd REST API. (See -U, --url.)