Skip to main content
    Ivy Biosciences Docs/Call the platform/Cli/CLI FAQ

    CLI FAQ

    Four ways to sign in, where settings and the error log live under ~/.config/ivybloom/, what one failed job does to a batch, and how to resume a session.

    faqtroubleshootingglossaryhelp

    This FAQ answers common questions about installing, authenticating, and running the ivybloom CLI, plus a glossary of key terms. Reach for it when you hit a snag — a command that won't run, an auth error, or a batch that partially failed — and want a quick answer before digging into the full guides. Because the CLI shares one backend and job history with the web platform, many answers here apply whether you work from the terminal or the web app. For the complete command set, see the CLI overview.

    Difficulty

    beginner

    CLI FAQ

    Frequently asked questions about the ivybloom CLI.


    Installation


    Authentication


    Jobs & Tools


    Configuration


    AI Models & BYOK


    Troubleshooting


    Batch Processing


    MCP & Agent Integration


    Sessions & Conversations


    Compounds & Science


    Organizations


    Getting Help

    In the CLI

    # General help
    ivybloom --help
    
    # Command-specific help
    ivybloom auth --help
    ivybloom jobs --help
    ivybloom run --help

    Resources


    Glossary

    TermDefinition
    ADMETAbsorption, Distribution, Metabolism, Excretion, Toxicity
    BatchCollection of jobs submitted and tracked as a unit
    BYOKBring Your Own Key — use personal AI provider API keys
    CampaignOrganizational unit grouping related chats and jobs
    CheckpointSnapshot of session state for rollback/time-travel
    CollectionSet of compounds stored together for analysis
    DockingPredicting how a small molecule binds to a protein
    ESMFoldMeta's protein structure prediction model
    MCPModel Context Protocol — AI agent ↔ tool standard
    pLDDTPredicted Local Distance Difference Test (0-100, higher=better)
    SAFESequential Attachment-based Fragment Embedding
    SMILESSimplified Molecular Input Line Entry System
    TUITerminal User Interface — the interactive dashboard
    Model familyA model provider, such as Anthropic or OpenAI; your plan sets which ones you can use

    Didn't find your answer?

    Contact Support for personalized help with your CLI questions.

    FAQ

    Was this page helpful?

    On this page

    On this page

    Loading...