CLI Quick Start
Install with the curl script or npm, sign in with ivybloom auth login --browser, then fold a sequence with ivybloom run esmfold and download the result.
This quick start walks you from install through your first job in under a minute, so you can drive protein folding, docking, and analysis from your terminal. Reach for it the first time you set up the CLI or when onboarding a teammate to the scriptable workflow. Everything you run here shares one backend and job history with the web platform, so results show up wherever you work. For the complete CLI surface, see the CLI overview.
Difficulty
Quick Start
Get up and running with the ivybloom CLI in under a minute.
Install
Verify installation:
For detailed installation options, troubleshooting, and CI/CD setup, see the Installation Guide.
Authenticate
Choose your preferred authentication method:
Browser Login (Recommended)
This opens your browser to authenticate with your Ivy Biosciences account.
API Key
Device Flow (SSH/Headless)
Follow the prompt to authenticate on another device.
For CI/CD pipelines, use environment variables:
Run Your First Analysis
Protein Structure Prediction
ADMET Property Prediction
Molecular Docking
Interactive Mode
Use guided form-based parameter entry:
Natural Language
Or describe what you want in plain English:
Follow Job Progress
Add --follow to watch job progress in real-time:
Or wait for completion with automatic polling:
Essential Commands
| Command | Description |
|---|---|
ivybloom auth login --browser | Authenticate with your account |
ivybloom auth status | Check authentication status |
ivybloom tools list | List available computational tools |
ivybloom run TOOL param=value | Submit a job |
ivybloom jobs list | List your jobs |
ivybloom jobs status JOB_ID | Check job status |
ivybloom jobs download JOB_ID | Download job results |
ivybloom | Launch the interactive dashboard |
ivybloom batch submit jobs.yaml | Run parallel jobs |
ivybloom compounds search COLL --type similarity --smiles "CCO" | Search compounds |
ivybloom orchestrate "fold BRCA1" | Natural language |
ivybloom mcp serve | Start MCP server |
ivybloom health --full | System diagnostics |
ivybloom --help | Show help |
Interactive Mode
For a conversational AI experience, launch the TUI:
The TUI provides:
- Chat interface with AI for drug discovery workflows
- Context panel showing files, jobs, and artifacts
- Slash commands via command palette (
Ctrl+P) - Real-time job monitoring with streaming updates
- File attachments (
@) and tool actions (!)
See the Interactive TUI Guide for keyboard shortcuts and features.
Or start a simpler interactive shell:
What's Next?
Choose your path:
Scientists
- Compounds — Build and search molecular libraries
- Protein Preparation — Prepare structures for docking
- Batch Processing — Screen compounds at scale
Developers
- MCP Integration — Connect AI agents to the platform tool catalog
- Agent Mode — Automate with structured JSON output
- Workflows — Build multi-step pipelines
Teams
- Organizations — Collaborate with team members
- Billing & Credits — Track usage and costs
- Sessions — Persistent conversations with checkpoints
Reference
- Commands Reference — Full command documentation
- Configuration — Customize CLI behavior
- FAQ — Common questions
Run curl -fsSL https://www.ivybiosciences.com/install | bash or npm install -g @ivybiosciences/ivybloom-cli to install the ivybloom CLI.
Run ivybloom auth login --browser to open browser-based authentication, or use --api-key for CI/CD pipelines.
Run ivybloom auth status and ivybloom health --full to confirm authentication and system connectivity.
Submit a job with ivybloom run esmfold protein_sequence=MKLVFFAEDVGSNKGAIIGLMVGGVVIA to predict a protein structure.
Use ivybloom jobs list to see your jobs and ivybloom jobs download JOB_ID --output ./results to retrieve results.
Was this page helpful?