Skip to Content
Getting Started

Getting Started with Bee CLI

Bee CLI is the command-line interface for interacting with your Bee data. It allows you to export your conversations, facts, todos, and more to local markdown files.

Two Ways to Work with Bee

You can work with Bee in two ways:

  1. CLI: Use bee commands directly in your terminal. This is usually the best option for AI agents because it provides markdown output by default, supports JSON when needed, and works well with local automation.
  2. API: Start a local HTTP API with bee proxy and call Bee over HTTP from your app or service. See API documentation.

This guide continues with the CLI workflow.

Prerequisites

To use the Bee CLI, you must have the Bee iOS app installed and Developer Mode unlocked by tapping app Version 5 times. See the Developer Mode guide.

Installation

npm install -g @beeai/cli

Verify the installation:

bee version

Output Modes

Data commands render markdown by default. Add --json when you need machine-readable output.

bee me

Authentication

Login to your Bee account

Run the login command:

bee login

Verify your connection

Check that you’re authenticated:

bee status

Test the connection

Ping the Bee servers:

bee ping

Your First Commands

Once authenticated, try these commands to explore your data:

# Get your user profile
bee me
 
# See your daily brief (calendar events, emails)
bee today
 
# View recent conversations from the last 10 hours
bee now
 
# List your facts
bee facts list
 
# List your todos
bee todos list
 
# Search your data (fast default mode)
bee search --query "project roadmap"
 
# Semantic search (slower neural mode)
bee search --query "What do you know about me?" --neural

Syncing Your Data

The most powerful feature of Bee CLI is the ability to sync your data to local markdown files:

bee sync

This creates a bee-sync/ directory with all your data organized in markdown format. See the Full Sync documentation for more details.

Logging Out

To clear your credentials:

bee logout

Next Steps

Last updated on
Developer Mode