Skip to main content

Quickstart

In this tutorial, you'll learn how to set up and start using the Pieces CLI. We'll cover the installation process and basic usage to help you get up and running quickly.

Install on PYPIInstall on PYPI

Prerequisites​

info

In order to use the Pieces Raycast Extension, you must have Pieces OS. We also recommend downloading the Pieces for Developers Desktop App.

Steps​

Step 1: Install the Pieces CLI​

  1. Ensure Pieces OS is installed and running on your system
  2. Install the Python package: 
    pip install pieces-cli
    Or via Homebrew: 
    brew install pieces-cli
    Or via Conda: 
    conda install pieces-cli

Step 2: Verify Installation​

  1. Open your terminal
  2. Run the following command to verify the installation: 
    pieces version
    If the installation was successful, you should see the version of the Pieces CLI.

Step 3: Explore Basic Commands​

Run the following command to see the available commands:

pieces help

Congratulations! You have successfully set up and started using the Pieces CLI.

Next Steps​

Explore more features and commands to streamline your workflow and boost productivity.