CLI Tool
Command-line interface for managing Fugoku Cloud infrastructure
Fugoku CLI
The Fugoku CLI is a command-line tool for managing your infrastructure from the terminal.
Coming Soon
The CLI is currently under development. In the meantime, use the REST API to manage your infrastructure programmatically.
Overview
The Fugoku CLI provides a fast, scriptable way to manage your infrastructure from the terminal. It wraps the Fugoku API and provides convenient commands for common operations.
Installation
Installation instructions will be available when the CLI is released.
Authentication
The CLI will support API key authentication via environment variable (FUGOKU_API_TOKEN) or interactive login.
Commands
The following commands are planned for the CLI:
Compute
fugoku instances list— List virtual machine instancesfugoku create instance— Create a virtual machine instancefugoku instances delete— Delete an instancefugoku instances start— Start an instancefugoku instances stop— Stop an instancefugoku instances reboot— Reboot an instancefugoku instances rebuild— Reinstall OS on an instancefugoku instances upgrade— Change instance planfugoku instances stats— View instance metricsfugoku instances get— Get instance detailsfugoku servers list— List bare metal serversfugoku create server— Create a bare metal serverfugoku servers delete— Delete a serverfugoku servers start— Start a serverfugoku servers stop— Stop a serverfugoku servers reboot— Reboot a serverfugoku servers rebuild— Reinstall OS on a serverfugoku servers upgrade— Change server planfugoku servers stats— View server metrics (including hardware health)fugoku servers get— Get server details (including hardware health)
Storage
fugoku volumes list— List volumesfugoku volumes create— Create a volumefugoku volumes attach— Attach a volume to a serverfugoku volumes detach— Detach a volume
Networking
fugoku networks list— List private networksfugoku networks create— Create a networkfugoku eips list— List elastic IPsfugoku eips create— Reserve a new elastic IPfugoku eips assign— Assign an elastic IP to an instance or load balancerfugoku eips move— Move an elastic IP to a different targetfugoku eips delete— Release an elastic IP
SSH Keys
fugoku ssh-keys list— List SSH keysfugoku ssh-keys add— Add an SSH keyfugoku ssh-keys delete— Delete an SSH keyfugoku ssh <instance>— SSH into an instance
Backups
fugoku snapshots enable— Enable automatic snapshots for an instance or volumefugoku snapshots create— Create a snapshotfugoku snapshots restore— Restore a snapshotfugoku snapshots copy— Copy a snapshot to another regionfugoku snapshots list— List snapshotsfugoku snapshots delete— Delete a snapshot
Alerts
fugoku alerts create— Create a monitoring alertfugoku alerts list— List alertsfugoku alerts delete— Delete an alert
Other
fugoku plans list— List available plansfugoku regions list— List available regionsfugoku images list— List available images
Using the API Today
While the CLI is not yet available, you can use the REST API directly:
# List servers
curl https://api.fugoku.com/v1/instances \
-H "X-Fugoku-API-Key: $FUGOKU_API_TOKEN"
# Create an instance
curl -X POST https://api.fugoku.com/v1/instances \
-H "X-Fugoku-API-Key: $FUGOKU_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"data": {
"type": "instances",
"attributes": {
"name": "web-1",
"site": "lagos-1",
"plan": "g-vm-2-4-80",
"operating_system": "ubuntu-22.04",
"billing": "hourly"
}
}
}'See the API Reference for full documentation.