Get started with the Pieces CLI tool

Build faster with AI long-term memory in your terminal. The Pieces CLI makes it easy to manage context, chat with Copilot, and streamline your dev workflow. All from the command line.

Installation via CLI


• Ensure Pieces OS is installed and running on your system.
• Run one of these commands:

pip install pieces-cli

Copied

pip install pieces-cli

Copied

pip install pieces-cli

Copied

brew install pieces-cli

Copied

brew install pieces-cli

Copied

brew install pieces-cli

Copied

conda install pieces-cli

Copied

conda install pieces-cli

Copied

conda install pieces-cli

Copied

List your assets, applications, and models

List your assets, applications, and models

Organize your workflow with Pieces List. View recent assets, connected apps, and 50+ AI models in one command. Switch between LLMs mid-chat to fit your needs.

Open Tools and Applets in Seconds

Launch PiecesOS or any applet instantly with pieces open. Whether you're jumping into a tool or switching contexts, this command opens exactly what you need with no extra steps or distractions.

Create, modify, and manage assets with ease

Use pieces save, create, edit, and delete to manage your assets efficiently. Capture snippets, update notes, and organize your development materials with ease. Structured metadata and asset tracking keep your workflow organized.

Find what matters

Use pieces search to quickly find saved snippets. Choose from Fuzzy, Neural Code, or Full Text Search to match your query style. Whether it's a function, command, or memory, Pieces CLI surfaces the right results in your terminal without leaving your IDE.

Customize your AI intelligence

Switch between 50+ local and cloud LLMs with pieces change_model [MODEL_INDEX]. Choose on-device speed or cloud-scale power to fit any task and adapt your AI workflow in real time.

Get help from Copilot

Use pieces ask "your question" to chat with Copilot in your terminal. Get help with debugging, docs, or tasks without leaving your IDE. Stay in flow with accurate, context-aware support.

Commit directly to GitHub

Auto-commit your code to GitHub with pieces commit -p for streamlined version control and issue tracking.

Use Pieces across your workflow

Seamlessly integrate Pieces into your daily tools and streamline every step of your coding process. From capturing snippets to surfacing context, Pieces connects it all, right when you need it.