Top commands#
Graphistry supports advanced command-line administration via the ./graphistry wrapper script, .yml / .env files, and caddy reverse-proxy configuration.
Important: Always use ./graphistry instead of raw docker compose commands. The ./graphistry script wraps docker compose with required environment context: GPU assignments, telemetry, and cluster mode settings. Configuration is loaded from data/config/custom.env, data/config/telemetry.env, and data/config/cluster.env. Users familiar with docker compose will find the same subcommands work (up, down, ps, logs, exec, etc.).
Login to server#
Image |
Command |
|---|---|
AWS |
|
Azure |
|
|
|
On-prem / BYOL |
Contact your admin |
CLI commands#
All likely require sudo. Run from where your docker-compose.yml file is located: /home/ubuntu/graphistry (AWS), /var/graphistry (Azure), or /var/graphistry/<releases>/<version> (recommended on-prem).
TASK |
COMMAND |
NOTES |
|---|---|---|
Install |
|
Install the |
Start |
|
Starts Graphistry, close with ctrl-c |
Start |
|
Starts Graphistry as background process |
Start |
|
Starts Graphistry in a specific namespace. Enables running multiple independent instances of Graphistry. NOTE: Must modify Caddy service in |
Stop |
|
Stops Graphistry |
Restart (soft) |
|
Soft restart. May also need to restart service |
Restart (hard) |
|
Restart with fresh state. May also need to restart service |
Reset |
|
Stop Graphistry, remove all internal state (including the user account database!), and start fresh . |
Status |
|
Status: Uptime, healthchecks, … |
GPU Status |
|
See GPU processes, compute/memory consumption, and driver. Ex: |
~~1.0 API Key~~ |
~~ |
REMOVED: API v1 VGraph has been permanently removed. Use JWT tokens via the v2 REST API. |
Logs |
|
Ex: Watch all logs, starting with the 20 most recent lines: |
Create Users |
Use Admin Panel (see Create Users) or |
|
Restart Docker Daemon |
|
Use when changing |
Jupyter shell |
|
Use for admin tasks like global package installs |