CLI overview

Use nod to create and operate Phoenixd nodes from your terminal. The CLI uses nod node for node operations, positional node IDs to select a node, and named flags for configuration.

Install

$ curl -fsSL https://nodana.io/cli | sh

Authenticate

Set your Nodana API key in the environment before running commands. Replace the placeholder with your key.

$ export NODANA_API_KEY="<your-api-key>"

Keep this key private. It authenticates the CLI to Nodana; your node's Phoenixd password authenticates requests to the node itself.

Create your first node

$ nod node create
$ nod node list

Save the node ID, endpoint, and any credentials or recovery information returned during creation. Use the node ID for subsequent operations. Creation stores the restricted password for dashboard access by default. Use nod node create --full if you want to send payments from the app.

Commands

Command	Purpose
`nod node list`	List your nodes
`nod node create`	Create a node
`nod node get <node-id>`	Inspect a node
`nod node start <node-id>`	Start a node
`nod node stop <node-id>`	Stop a node
`nod node restart <node-id>`	Restart a node
`nod node update <node-id>`	Apply an available Phoenixd update
`nod node delete <node-id>`	Delete a node

Help

$ nod --help
$ nod node --help
$ nod node create --help