Guides
Guide: CLI Use the imboard CLI to manage boards, meetings, documents, and reports from your terminal.
The I'mBoard CLI (@imboard/cli) is a command-line interface that wraps the I'mBoard REST API. It maps 1:1 with the MCP server tools — same API, same token, terminal-native.
Approach Best For REST API (curl, SDK)Custom integrations, CI/CD pipelines, programmatic access CLI Quick lookups, scripting, agent workflows, terminal power users MCP server (Claude Code)AI-assisted exploration, natural language queries
npm install -g @imboard/cli Or run without installing:
The CLI resolves credentials in this order (highest priority first):
CLI flags : --token and --api-urlEnvironment variables : IMBOARD_API_TOKEN and IMBOARD_API_BASE_URLConfig file : ~/.imboard/config.json
export IMBOARD_API_BASE_URL = https://app.imboard.ai export IMBOARD_API_TOKEN = imb_pat_YOUR_TOKEN_HERE imboard config set api-url https://app.imboard.ai imboard config set token imb_pat_YOUR_TOKEN_HERE The config file is stored at ~/.imboard/config.json with restricted permissions (600).
Human-readable (default): formatted tables and key-value pairs with color.
JSON (--json): raw JSON for piping to jq or consuming from scripts.
imboard boards list --json | jq '.[].name' No color (--no-color): plain text without ANSI escape codes.
Command Description imboard meShow authenticated user profile imboard user boardsList all boards for current user imboard user storageShow storage usage
Command Description imboard boards listList all boards imboard boards get <id>Get board details imboard boards create --name "Q1 Board"Create a board imboard boards update <id> --name "New Name"Update a board imboard boards search <id> --query "revenue"Semantic search imboard boards action-items <id>List board action items imboard boards roles <id> <userId> --admin-role adminAssign roles
Command Description imboard members list --board <id>List board members imboard members get <memberId> --board <id>Get member details
Command Description imboard meetings list --board <id>List meetings imboard meetings get <id> --board <id>Get meeting details imboard meetings create --board <id> --title "Q1 Review" ...Create a meeting imboard meetings update <id> --board <id> --title "Updated"Update a meeting imboard meetings delete <id> --board <id>Delete a meeting imboard meetings status <id> --board <id> --status scheduledChange status
Command Description imboard documents list --board <id>List documents imboard documents get <docId> --board <id>Get document imboard documents create --board <id> --title "Minutes"Create a document imboard documents update <docId> --board <id>Update a document imboard documents delete <docId> --board <id>Delete a document imboard documents status <docId> --board <id> --status approvedChange status imboard documents version <docId> --board <id> --external-link <url>New version
Command Description imboard reports list --board <id>List reports imboard reports get <reportId> --board <id>Get report imboard reports create --board <id> --name "Q1"Create a report imboard reports update <reportId> --board <id>Update a report imboard reports promote <reportId> --board <id> --status finalizedPromote status imboard reports followup <reportId> --board <id> --name "Q2"Create follow-up imboard reports audit <reportId> --board <id>Trigger audit imboard reports audits <reportId> --board <id>List audits imboard reports audit-detail <reportId> <auditId> --board <id>Audit detail
Command Description imboard dashboards list --board <id> --report <id>List dashboards imboard dashboards get <dashId> --board <id> --report <id>Get dashboard imboard dashboards create --board <id> --report <id> --name "Revenue"Create imboard dashboards version <dashId> --board <id> --report <id> --content '{...}'New version imboard dashboards review-status <dashId> --board <id> --report <id> --status approvedReview imboard dashboards chat <dashId> --board <id> --report <id>Get chat imboard dashboards post-chat <dashId> --board <id> --report <id> --message "..." --type internalPost chat imboard dashboards feedback --board <id> --report <id>Get feedback imboard dashboards post-feedback --board <id> --report <id> --message "..." --recipient <userId>Post feedback
Command Description imboard metrics history --board <id>Historical metrics imboard metrics compare --board <id> --metric revenue --base 2025-01 --comparison 2025-02Compare
Command Description imboard slots list --board <id> --meeting <id>List proposed slots imboard slots create --board <id> --meeting <id> --start-time <iso> --timezone <tz>Propose slot imboard slots vote <slotId> --board <id> --meeting <id> --vote okVote imboard slots delete <slotId> --board <id> --meeting <id>Delete slot imboard slots confirm <slotId> --board <id> --meeting <id>Confirm slot
Command Description imboard invites list --board <id>List invitations imboard invites create --board <id> --email [email protected] Send invite imboard invites accept <id>Accept imboard invites decline <id>Decline imboard invites retract <id>Retract
Command Description imboard notifications listList notifications imboard notifications read <id>Mark as read imboard notifications read-allMark all as read
Command Description imboard action-items listList my action items imboard action-items update <id> --status completedUpdate status
Command Description imboard audit-log <boardId>Board audit log imboard portfolioPortfolio data imboard fx-ratesExchange rates imboard attachments listUnassigned attachments imboard attachments reject <id>Reject attachment
Command Description imboard config set token <value>Save API token imboard config set api-url <value>Save API URL imboard config showShow effective config imboard config clearDelete config file
Code Meaning 0 Success 1 Configuration error 2 API error (4xx/5xx) 3 Network or timeout error 4 Invalid arguments
List commands that support pagination accept --limit, --cursor, --sort, and --order:
imboard boards list --limit 10 --sort createdAt --order asc When more results are available, the CLI prints the cursor for the next page:
More results available. Use --cursor abc123def456 List all board names:
imboard boards list --json | jq -r '.[].name' Find overdue action items:
imboard action-items list --json | jq '[.[] | select(.status == "open")]' Create a meeting and capture the ID:
MEETING_ID = $( imboard meetings create \ --board " $BOARD_ID " \ --title "Q2 Review" \ --status draft \ --location-type virtual \ --start-time "2025-07-15T14:00:00Z" \ --end-time "2025-07-15T15:00:00Z" \ --json | jq -r '._id' ) 