CLI Quickstart¶
Create a notebook Session from a terminal, open it, inspect it, and clean it up.
1. Install¶
pip install canfar --upgrade
2. Log in¶
canfar login cadc
Use SRCNet when that is your IDP:
canfar login srcnet
Check the active Authentication and available Servers:
canfar auth show
canfar server ls
3. Create a notebook¶
canfar create notebook skaha/astroml:latest
The image shorthand skaha/astroml:latest resolves to the CANFAR image
registry. Use the full image name when you want to be explicit:
canfar create notebook images.canfar.net/skaha/astroml:latest
4. Check status¶
canfar ps
canfar info $(canfar ps -q)
Use machine output in scripts:
canfar ps --json
5. Open the notebook¶
canfar open $(canfar ps -q)
Notebook Sessions usually take 60-120 seconds to become reachable.
6. Inspect startup events¶
canfar events $(canfar ps -q)
canfar logs $(canfar ps -q)
7. Clean up¶
canfar delete $(canfar ps -q)
Skip the confirmation prompt when you are scripting:
canfar delete $(canfar ps -q) --force
Fixed resources¶
Omit resources for flexible allocation. Set --cpu, --memory, or --gpu
when you need fixed resources.
canfar create notebook skaha/astroml:latest --cpu 4 --memory 16
Headless job¶
Use -- before the command that should run inside the container.
canfar create headless skaha/terminal:1.1.2 -- python /arc/projects/demo/run.py
Troubleshooting¶
| Symptom | Command |
|---|---|
| Need fresh credentials | canfar login cadc --force --debug |
| Need another Server | canfar server ls then canfar server use <name-or-uri> |
| Session is pending | canfar events $(canfar ps -q) |
| Need cluster capacity | canfar stats |
| Need structured output | canfar ps --json |