ganimede
The main command to run Ganimede in production mode.Path to the notebook file (.ipynb) you want to open. Can be absolute or relative path.
Example
How it works
- Starts a Starlette/Uvicorn server on
0.0.0.0:8000 - Initializes a Yjs WebSocket server for collaborative editing on port
1234 - Sets the
NOTEBOOK_LOCenvironment variable to the absolute path of your notebook - Runs without hot reload (production mode)
ganimede_dev
Development mode with hot reload for Ganimede development.Path to the notebook file (.ipynb) you want to open. Can be absolute or relative path.
Example
How it works
- Same as
ganimedebut with additional features: - Enables Uvicorn hot reload (automatically restarts server on code changes)
- Sets the
DEVenvironment variable to"True" - Useful for developing and debugging Ganimede itself
Environment Variables
Ganimede uses the following environment variables (set automatically by the CLI):Absolute path to the notebook file being edited. Set automatically when you run
ganimede or ganimede_dev.Set to
"True" when using ganimede_dev. Enables development mode features.Server Details
- Web Server:
http://0.0.0.0:8000 - Yjs WebSocket:
ws://localhost:1234 - Log Level: INFO with Rich formatting