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.
When to Use the CLI
| 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 |
Installation
npm install -g @imboard/cliOr run without installing:
npx @imboard/cli meConfiguration
The CLI resolves credentials in this order (highest priority first):
- CLI flags:
--tokenand--api-url - Environment variables:
IMBOARD_API_TOKENandIMBOARD_API_BASE_URL - Config file:
~/.imboard/config.json
Option 1: Environment Variables (recommended)
export IMBOARD_API_BASE_URL=https://app.imboard.ai
export IMBOARD_API_TOKEN=imb_pat_YOUR_TOKEN_HEREOption 2: Config File
imboard config set api-url https://app.imboard.ai
imboard config set token imb_pat_YOUR_TOKEN_HEREThe config file is stored at ~/.imboard/config.json with restricted permissions (600).
Verify
imboard meOutput Modes
Human-readable (default): formatted tables and key-value pairs with color.
imboard boards listJSON (--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.
Commands
Account
| Command | Description |
|---|---|
imboard me | Show authenticated user profile |
imboard user boards | List all boards for current user |
imboard user storage | Show storage usage |
Boards
| Command | Description |
|---|---|
imboard boards list | List 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 admin | Assign roles |
Members
| Command | Description |
|---|---|
imboard members list --board <id> | List board members |
imboard members get <memberId> --board <id> | Get member details |
Meetings
| 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 scheduled | Change status |
Documents
| 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 approved | Change status |
imboard documents version <docId> --board <id> --external-link <url> | New version |
Reports
| 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 finalized | Promote 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 |
Dashboards
| 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 approved | Review |
imboard dashboards chat <dashId> --board <id> --report <id> | Get chat |
imboard dashboards post-chat <dashId> --board <id> --report <id> --message "..." --type internal | Post chat |
imboard dashboards feedback --board <id> --report <id> | Get feedback |
imboard dashboards post-feedback --board <id> --report <id> --message "..." --recipient <userId> | Post feedback |
Metrics
| Command | Description |
|---|---|
imboard metrics history --board <id> | Historical metrics |
imboard metrics compare --board <id> --metric revenue --base 2025-01 --comparison 2025-02 | Compare |
Meeting Slots
| 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 ok | Vote |
imboard slots delete <slotId> --board <id> --meeting <id> | Delete slot |
imboard slots confirm <slotId> --board <id> --meeting <id> | Confirm slot |
Invitations
| 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 |
Notifications
| Command | Description |
|---|---|
imboard notifications list | List notifications |
imboard notifications read <id> | Mark as read |
imboard notifications read-all | Mark all as read |
Action Items
| Command | Description |
|---|---|
imboard action-items list | List my action items |
imboard action-items update <id> --status completed | Update status |
Supporting
| Command | Description |
|---|---|
imboard audit-log <boardId> | Board audit log |
imboard portfolio | Portfolio data |
imboard fx-rates | Exchange rates |
imboard attachments list | Unassigned attachments |
imboard attachments reject <id> | Reject attachment |
Configuration
| Command | Description |
|---|---|
imboard config set token <value> | Save API token |
imboard config set api-url <value> | Save API URL |
imboard config show | Show effective config |
imboard config clear | Delete config file |
Exit Codes
| Code | Meaning |
|---|---|
| 0 | Success |
| 1 | Configuration error |
| 2 | API error (4xx/5xx) |
| 3 | Network or timeout error |
| 4 | Invalid arguments |
Pagination
List commands that support pagination accept --limit, --cursor, --sort, and --order:
imboard boards list --limit 10 --sort createdAt --order ascWhen more results are available, the CLI prints the cursor for the next page:
More results available. Use --cursor abc123def456Scripting Examples
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')MCP — install & tool reference
Connect I'mBoard to claude.ai with one URL (no install), or install the MCP server in Claude Code, Claude Desktop, Cursor, Cline, and other MCP-aware clients. Includes the full live tool catalog.
Knowledge Base
Learn how to use I'mBoard to run your board meetings, manage documents, and keep stakeholders informed.