CLI Reference
The nf CLI is the primary interface for managing NodeFoundry from the command line. Install it on any machine with network access to the master node.
Installation
$ curl -fsSL https://get.nodefoundry.io/cli | bash
$ brew install nodefoundry/tap/nf
Configuration
The CLI reads connection settings from a .nf.json file in the current directory. This file stores the API host, port, and authentication token.
Authentication
Log in with nf user login to store a session token:
$ nf user login --username admin --password secret Logged in as Admin (admin)
Global flags
All commands support the following global flag:
| Flag | Description |
|---|---|
--json | Output results as JSON instead of styled terminal output |
Command index
Node
List and inspect registered nodes.
Images
Manage OS images for network booting.
Ceph
Manage Ceph daemons: MON, OSD, MDS, MGR, RGW, and CephFS.
Network
Configure networks with DHCP and DNS.
Disks
View disk inventory across all nodes.
S3
Manage S3-compatible buckets and objects.
User
Authentication and user management.
SSH Keys
Manage SSH public keys for node access.
NICs
List network interfaces across nodes.
Tasks
View recent background task runs.
Templates
Manage provisioning configuration templates.
License
View license details and limits.