Skip to content

Latest commit

 

History

History
160 lines (111 loc) · 4.11 KB

README.md

File metadata and controls

160 lines (111 loc) · 4.11 KB
Raw

Pieces CLI for Developers

Pieces Python CLI Tool

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.

Website • Pieces OS Documentation • Pieces Python CLI Documentation

Introducing CLI

Important

Make sure you have Pieces OS 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 Pieces OS is installed and running on your system.

  2. Install the Python package:

    pip install pieces-cli
    brew install pieces-cli
    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.

Contributing

Installation

To run this project locally, follow these steps:

  1. Fork this project via GitHub.

  2. Clone this project:

git clone https://github.com/pieces-app/cli-agent
  1. Create a Virtual Environment
python3 -m venv venv
  1. Activate Your Virtualenv
source venv/bin/activate for Mac & Linux OS

cd venv\Scripts for Windows OS
activate
  1. This project uses poetry for managing dependencies and builds. Install poetry with:
pip install poetry
  1. Then use poetry to install the required dependencies
poetry install
  1. You build with
poetry build
  1. Finally any project dependencies should be added to the pyproject.toml file with
poetry add
  1. Open the Dist folder
cd dist
  1. Install the WHL file
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 of the cli-agent

  1. To view all the CLI Commands
pieces help

these can be local/github/pypi etc.

Updating

To update the project, run the following command:

pip install pieces-cli --upgrade

Testing

To discover and run all the test cases in the repository, run the following command:

pytest

To check the test coverage, you can use the coverage package. Install coverage with:

pip install coverage

Run the tests with coverage using the following command:

coverage run -m pytest
coverage report

Uninstallation

To uninstall the project, run the following command:

pip uninstall pieces-cli

Don't forget to remove the virtual environment and dist folder