<p align="center">
# <p align="center"> Pieces Python CLI Tool
<p align="center"> This is a comprehensive command-line interface (CLI) tool designed to interact seamlessly with PiecesOS. It provides a range of functionalities such as asset management, application interaction, and integration with various PiecesOS features.
</p>
##### <p align="center"> [Website](https://pieces.app/) • [PiecesOS Documentation](https://docs.pieces.app/) • [Pieces Python CLI Documentation](https://docs.pieces.app/extensions-plugins/cli)
</p>
[](https://www.youtube.com/watch?v=kAgwHMxWY8c)
## Important
Make sure you have [**PiecesOS**](https://docs.pieces.app/installation-getting-started/what-am-i-installing) installed in order to run the Pieces CLI tool.
#### Operating System Support
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
## Installing
To get started with the Pieces Python CLI Tool, you need to:
1. Ensure PiecesOS is installed and running on your system.
2. Install the Python package:
```bash
pip install pieces-cli
```
```bash
brew install pieces-cli
```
```bash
conda install pieces-cli
```
## Getting Started
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.
### Some important terminologies
- `x` -> The index
- `current asset` -> The asset that you are currently using can be changed by the open command
- `current conversation` -> The conversation that you currently using in the ask command
## Usage
To refer to the list of all the commands currently supported in the Pieces CLI Agent, visit the [documentation](https://docs.pieces.app/extensions-plugins/cli/commands).
## Contributing
### Installation
To run this project locally, follow these steps:
1. Fork this project via GitHub.
2. Clone this project:
```shell
git clone https://github.com/pieces-app/cli-agent
```
3. Create a Virtual Environment
```shell
python3 -m venv venv
```
4. Activate Your Virtualenv
```shell
source venv/bin/activate for Mac & Linux OS
cd venv\Scripts for Windows OS
activate
```
5. This project uses poetry for managing dependencies and builds. Install poetry with:
```shell
pip install poetry
```
6. Then use poetry to install the required dependencies
```shell
poetry install
```
7. You build with
```shell
poetry build
```
8. Finally any project dependencies should be added to the pyproject.toml file with
```shell
poetry add
```
9. Open the Dist folder
```shell
cd dist
```
10. Install the WHL file
```shell
pip install pieces-cli-{VERSION}-py3-none-any.whl
```
replace the VERSION with the version you downloaded
Note: Ensure you get latest from the [releases](https://github.com/pieces-app/cli-agent/releases) of the cli-agent
11. To view all the CLI Commands
```shell
pieces help
```
these can be local/github/pypi etc.
### Updating
To update the project, run the following command:
```shell
pip install pieces-cli --upgrade
```
### Testing
To discover and run all the test cases in the repository, run the following command:
```shell
pytest
```
To check the test coverage, you can use the coverage package. Install coverage with:
```shell
pip install coverage
```
Run the tests with coverage using the following command:
```shell
coverage run -m pytest
coverage report
```
### Uninstallation
To uninstall the project, run the following command:
```shell
pip uninstall pieces-cli
```
Don't forget to remove the virtual environment and dist folder
Raw data
{
"_id": null,
"home_page": "https://pieces.app",
"name": "pieces-cli",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.14,>=3.11",
"maintainer_email": null,
"keywords": "copilot, pieces, ai, snippets",
"author": "Pieces",
"author_email": "development@pieces.app",
"download_url": "https://files.pythonhosted.org/packages/a9/8b/9b77dfd78cac00bc251e0e237a0f100284dde0b6359fd38b21dc28218137/pieces_cli-1.9.1.tar.gz",
"platform": null,
"description": "\n<p align=\"center\">\n\n# <p align=\"center\"> Pieces Python CLI Tool\n\n<p align=\"center\"> This is a comprehensive command-line interface (CLI) tool designed to interact seamlessly with PiecesOS. It provides a range of functionalities such as asset management, application interaction, and integration with various PiecesOS features.\n\n</p>\n \n##### <p align=\"center\"> [Website](https://pieces.app/) \u2022 [PiecesOS Documentation](https://docs.pieces.app/) \u2022 [Pieces Python CLI Documentation](https://docs.pieces.app/extensions-plugins/cli)\n</p>\n\n[](https://www.youtube.com/watch?v=kAgwHMxWY8c)\n\n## Important\n\nMake sure you have [**PiecesOS**](https://docs.pieces.app/installation-getting-started/what-am-i-installing) installed in order to run the Pieces CLI tool.\n\n#### Operating System Support\nThe 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.\n\nThe CLI Supports\n- Windows 10 or greater\n- Mac\n- Windows\n\n## Installing\nTo get started with the Pieces Python CLI Tool, you need to:\n\n1. Ensure PiecesOS is installed and running on your system.\n2. Install the Python package:\n\n ```bash\n pip install pieces-cli\n ```\n\n ```bash\n brew install pieces-cli\n ```\n\n ```bash\n conda install pieces-cli\n ```\n\n## Getting Started\nAfter 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.\n\n\n### Some important terminologies\n\n- `x` -> The index\n- `current asset` -> The asset that you are currently using can be changed by the open command \n- `current conversation` -> The conversation that you currently using in the ask command\n\n\n## Usage\n\nTo refer to the list of all the commands currently supported in the Pieces CLI Agent, visit the [documentation](https://docs.pieces.app/extensions-plugins/cli/commands).\n\n## Contributing\n\n\n### Installation\nTo run this project locally, follow these steps:\n\n1. Fork this project via GitHub. \n\n2. Clone this project: \n```shell\ngit clone https://github.com/pieces-app/cli-agent\n```\n\n3. Create a Virtual Environment\n```shell\npython3 -m venv venv\n``` \n\n4. Activate Your Virtualenv\n```shell\nsource venv/bin/activate for Mac & Linux OS\n\ncd venv\\Scripts for Windows OS\nactivate \n```\n\n5. This project uses poetry for managing dependencies and builds. Install poetry with:\n```shell\npip install poetry\n```\n\n6. Then use poetry to install the required dependencies\n```shell\npoetry install\n```\n\n7. You build with\n```shell\npoetry build\n```\n\n8. Finally any project dependencies should be added to the pyproject.toml file with\n```shell\npoetry add \n```\n\n9. Open the Dist folder\n```shell\ncd dist\n``` \n\n10. Install the WHL file\n```shell\npip install pieces-cli-{VERSION}-py3-none-any.whl \n```\nreplace the VERSION with the version you downloaded\nNote: Ensure you get latest from the [releases](https://github.com/pieces-app/cli-agent/releases) of the cli-agent\n\n\n11. To view all the CLI Commands\n```shell \npieces help \n``` \n\nthese can be local/github/pypi etc.\n\n\n### Updating\nTo update the project, run the following command:\n\n```shell\npip install pieces-cli --upgrade\n```\n\n\n### Testing\nTo discover and run all the test cases in the repository, run the following command:\n\n```shell\npytest\n```\n\nTo check the test coverage, you can use the coverage package. Install coverage with:\n```shell\npip install coverage\n```\n\nRun the tests with coverage using the following command:\n```shell\ncoverage run -m pytest\ncoverage report\n```\n\n### Uninstallation\nTo uninstall the project, run the following command:\n\n```shell\npip uninstall pieces-cli\n```\nDon't forget to remove the virtual environment and dist folder\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A powerful cli tool to interact with PiecesOS",
"version": "1.9.1",
"project_urls": {
"Homepage": "https://pieces.app",
"Repository": "https://github.com/pieces-app/cli-agent"
},
"split_keywords": [
"copilot",
" pieces",
" ai",
" snippets"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8f526457655337e0c33dd73ccb72e46a309d2ddedbde99cd534f8c280a3d6815",
"md5": "72278a4199540ea2949387bbdd22bd04",
"sha256": "c0534dbfb330d8337fec3d10983de49978675bad3c3c925c8fed77e1a3d49176"
},
"downloads": -1,
"filename": "pieces_cli-1.9.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "72278a4199540ea2949387bbdd22bd04",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.14,>=3.11",
"size": 66141,
"upload_time": "2025-01-09T20:35:29",
"upload_time_iso_8601": "2025-01-09T20:35:29.665337Z",
"url": "https://files.pythonhosted.org/packages/8f/52/6457655337e0c33dd73ccb72e46a309d2ddedbde99cd534f8c280a3d6815/pieces_cli-1.9.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a98b9b77dfd78cac00bc251e0e237a0f100284dde0b6359fd38b21dc28218137",
"md5": "b8ca6066c21a58744c4b490f66da71d0",
"sha256": "1dda0b299fb70455a25adfbe8ef477f4871c9bf85602f2918067ce8da5d74ba9"
},
"downloads": -1,
"filename": "pieces_cli-1.9.1.tar.gz",
"has_sig": false,
"md5_digest": "b8ca6066c21a58744c4b490f66da71d0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.14,>=3.11",
"size": 47208,
"upload_time": "2025-01-09T20:35:31",
"upload_time_iso_8601": "2025-01-09T20:35:31.993168Z",
"url": "https://files.pythonhosted.org/packages/a9/8b/9b77dfd78cac00bc251e0e237a0f100284dde0b6359fd38b21dc28218137/pieces_cli-1.9.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-09 20:35:31",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "pieces-app",
"github_project": "cli-agent",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pieces-cli"
}
JSON
