This is a comprehensive command-line interface (CLI) tool designed to interact seamlessly with Pieces OS. It provides a range of functionalities such as asset management, application interaction, and integration with various Pieces OS features.
The Pieces Python CLI Tool is compatible with various operating systems, ensuring a wide range of usage and adaptability. While it offers full support across most systems, specific features might have varied performance based on the OS environment.
The CLI Supports
- Windows 10 or greater
- Mac
- Windows
To get started with the Pieces Python CLI Tool, you need to:
-
Ensure Pieces OS is installed and running on your system.
-
Install the Python package:
pip install pieces-cli
brew install pieces-cli
conda install pieces-cli
After installing the CLI tool, you can access its functionalities through the terminal. The tool is initialized with the command pieces
followed by various subcommands and options.
The run command starts the CLI in a loop. While you can use each command without running the CLI in a loop you'll get much faster results and a better experience using run.
Once the CLI is running in a loop you can simply type the command.
For instance:
open
Instead of:
pieces open
If you have a numbered list or search open you can just type the number and it will open the asset associated.
pieces run
To list assets or applications, use the command:
pieces list
pieces list x
pieces list apps
pieces list models
Opens an asset from a list or search. If only "open" is used then it will open your most recent asset. This also creates a link to the asset's code.
pieces open [ITEM_INDEX]
** Does Not Currently Work **
pieces save
Will take whatever text is copied to your clipboard and create an asset. The asset will automatically be scanned and recognized for it's file type.
pieces create
This currently only works for an assets's name
pieces edit
This will delete an opened asset by using list or search first. If you do not have an opened asset it will open your most recent asset and ask if you'd like to delete it.
pieces delete
pieces search [your query]
Finds strings that approximately match patterns. Normal search.
pieces search query --mode ncs
Uses machine learning, deep neural networks, and natural language processing. It can understand the intent of a user's search query and match it with the most relevant results.
pieces search query --mode fts
Examines all words in a document to find matches to search criteria
** Requires quotes around question **
This currently only supports GPT 3.5 and it does not have working memory. Only coding questions are currently supported. To use the model's code you can copy it from the console and use the create command to create an asset using the copied code.
pieces ask "your question"
pieces version
pieces help
- Windows 10 or Greater
- Mac (insert later)
- Linux (insert later)
It is advised to keep the CLI tool updated to the latest version to ensure compatibility with Pieces OS and access to all features. Please refer to our documentation for details on supported versions.