pieces-cli 1.1.0__tar.gz

pieces_cli-1.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Pieces.app
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

pieces_cli-1.1.0/PKG-INFO

@@ -0,0 +1,281 @@
+Metadata-Version: 2.3
+Name: pieces-cli
+Version: 1.1.0
+Summary: A powerful cli tool to interact with PiecesOS 
+License: MIT
+Keywords: copilot,pieces,ai,snippets,materials
+Author: Pieces
+Author-email: development@pieces.app
+Requires-Python: >=3.11,<3.14
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Dist: aenum (>=3.1.11)
+Requires-Dist: mcp (==1.8.0)
+Requires-Dist: platformdirs (>=4.2.0,<5.0.0)
+Requires-Dist: prompt-toolkit (>=3.0.43,<4.0.0)
+Requires-Dist: pyperclip (>=1.8.2)
+Requires-Dist: python-dateutil (>=2.8.2)
+Requires-Dist: pyyaml (>=6.0.2,<7.0.0)
+Requires-Dist: rich (>=13.7.1,<14.0.0)
+Requires-Dist: urllib3 (>=1.25.3)
+Requires-Dist: websocket-client (>=1.8.0,<2.0.0)
+Project-URL: Homepage, https://pieces.app
+Project-URL: Repository, https://github.com/pieces-app/cli-agent
+Description-Content-Type: text/markdown
+
+# 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 CLI Documentation](https://docs.pieces.app/extensions-plugins/cli)
+</p>
+
+[![Introducing CLI](https://img.youtube.com/vi/kAgwHMxWY8c/0.jpg)](https://www.youtube.com/watch?v=kAgwHMxWY8c)
+
+## Important
+
+Make sure you have [**PiecesOS**](https://docs.pieces.app/products/meet-pieces/fundamentals) 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
+
+## Shell Completion
+
+The Pieces CLI supports auto-completion for bash, zsh, fish, and PowerShell. To enable completion for your shell, run:
+
+```bash
+pieces completion [shell]
+```
+
+**Quick setup commands for each shell:**
+
+- **Bash:**
+```bash
+echo 'eval "$(pieces completion bash)"' >> ~/.bashrc && source ~/.bashrc
+```
+
+- **Zsh:**
+```zsh
+echo 'eval "$(pieces completion zsh)"' >> ~/.zshrc && source ~/.zshrc
+```
+
+- **Fish:**
+```fish
+echo 'pieces completion fish | source' >> ~/.config/fish/config.fish && source ~/.config/fish/config.fish
+```
+
+- **PowerShell:**
+```powershell
+Add-Content $PROFILE '$completionPiecesScript = pieces completion powershell | Out-String; Invoke-Expression $completionPiecesScript'; . $PROFILE
+```
+
+After setup, restart your terminal or source your configuration file. Then try typing `pieces ` and press **Tab** to test auto-completion!
+
+## 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
+
+## Available Commands
+
+```
+  run               - Starts a looped version of the CLI that only requires you to type the flag
+
+  list              - Lists all the materials in your Pieces Drive (alias: 'drive')
+  list apps         - List all registered applications
+  list models       - List all registered AI models and change the AI model that you are using the ask command
+
+  modify            - Modify the current material content after you edit it in the editor
+  edit              - Edit the current material name or classification you can use -n and -c for name and classification respectively
+  delete            - Deletes the current or most recent material.
+  create            - Creates a new material based on what you've copied to your clipboard
+  execute           - Execute a Pieces bash material
+  clear             - to clear the terminal
+
+  config            - View current configuration
+  config --editor x - Set the editor to 'x' in the configuration
+
+  ask "ask"       - Asks a single question to the model selected in change model. Default timeout set to 10 seconds
+  --materials,-m    - Add material(s) by index. Separate materials with spaces. Run 'drive' to find material indexes
+  --file,-f         - Add a certain files or folders to the ask command it can be absolute or relative path
+
+  chats             - List all the chats. The green chat shows the currently using one in the ask command
+  chat              - Show the messages of the currently using chat in the ask command
+  chat x            - List all the messages in a certain chat and switch to it in the ask command
+  -n,--new          - To create a new chat in the ask command
+  -d,--delete       - Deletes the current chat
+  -r,--rename       - Rename the current chat. If no value given it will let the model rename it for you
+
+  commit            - Commits the changes to github and auto generate the message, you can use -p or --push to push
+
+  search q          - Does a fuzzy search for your query
+  --mode ncs        - Does a neural code search for your query
+  --mode fts        - Does a full text search for your query
+
+  login             - Login to pieces
+  logout            - Logout from pieces
+
+  version           - Gets version of PiecesOS and the version of the cli tool
+  help              - Show this help message
+  onboarding        - Start the onboarding process
+  feedback          - Send feedback to Pieces
+  contribute        - Contribute to Pieces CLI
+  install           - Install PiecesOS
+  open              - Opens PiecesOS
+```
+

pieces_cli-1.1.0/README.md

@@ -0,0 +1,252 @@
+# 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 CLI Documentation](https://docs.pieces.app/extensions-plugins/cli)
+</p>
+
+[![Introducing CLI](https://img.youtube.com/vi/kAgwHMxWY8c/0.jpg)](https://www.youtube.com/watch?v=kAgwHMxWY8c)
+
+## Important
+
+Make sure you have [**PiecesOS**](https://docs.pieces.app/products/meet-pieces/fundamentals) 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
+
+## Shell Completion
+
+The Pieces CLI supports auto-completion for bash, zsh, fish, and PowerShell. To enable completion for your shell, run:
+
+```bash
+pieces completion [shell]
+```
+
+**Quick setup commands for each shell:**
+
+- **Bash:**
+```bash
+echo 'eval "$(pieces completion bash)"' >> ~/.bashrc && source ~/.bashrc
+```
+
+- **Zsh:**
+```zsh
+echo 'eval "$(pieces completion zsh)"' >> ~/.zshrc && source ~/.zshrc
+```
+
+- **Fish:**
+```fish
+echo 'pieces completion fish | source' >> ~/.config/fish/config.fish && source ~/.config/fish/config.fish
+```
+
+- **PowerShell:**
+```powershell
+Add-Content $PROFILE '$completionPiecesScript = pieces completion powershell | Out-String; Invoke-Expression $completionPiecesScript'; . $PROFILE
+```
+
+After setup, restart your terminal or source your configuration file. Then try typing `pieces ` and press **Tab** to test auto-completion!
+
+## 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
+
+## Available Commands
+
+```
+  run               - Starts a looped version of the CLI that only requires you to type the flag
+
+  list              - Lists all the materials in your Pieces Drive (alias: 'drive')
+  list apps         - List all registered applications
+  list models       - List all registered AI models and change the AI model that you are using the ask command
+
+  modify            - Modify the current material content after you edit it in the editor
+  edit              - Edit the current material name or classification you can use -n and -c for name and classification respectively
+  delete            - Deletes the current or most recent material.
+  create            - Creates a new material based on what you've copied to your clipboard
+  execute           - Execute a Pieces bash material
+  clear             - to clear the terminal
+
+  config            - View current configuration
+  config --editor x - Set the editor to 'x' in the configuration
+
+  ask "ask"       - Asks a single question to the model selected in change model. Default timeout set to 10 seconds
+  --materials,-m    - Add material(s) by index. Separate materials with spaces. Run 'drive' to find material indexes
+  --file,-f         - Add a certain files or folders to the ask command it can be absolute or relative path
+
+  chats             - List all the chats. The green chat shows the currently using one in the ask command
+  chat              - Show the messages of the currently using chat in the ask command
+  chat x            - List all the messages in a certain chat and switch to it in the ask command
+  -n,--new          - To create a new chat in the ask command
+  -d,--delete       - Deletes the current chat
+  -r,--rename       - Rename the current chat. If no value given it will let the model rename it for you
+
+  commit            - Commits the changes to github and auto generate the message, you can use -p or --push to push
+
+  search q          - Does a fuzzy search for your query
+  --mode ncs        - Does a neural code search for your query
+  --mode fts        - Does a full text search for your query
+
+  login             - Login to pieces
+  logout            - Logout from pieces
+
+  version           - Gets version of PiecesOS and the version of the cli tool
+  help              - Show this help message
+  onboarding        - Start the onboarding process
+  feedback          - Send feedback to Pieces
+  contribute        - Contribute to Pieces CLI
+  install           - Install PiecesOS
+  open              - Opens PiecesOS
+```

pieces_cli-1.1.0/pyproject.toml

@@ -0,0 +1,48 @@
+[tool.poetry]
+name = "pieces-cli"
+version = "1.1.0"
+description = "A powerful cli tool to interact with PiecesOS "
+authors = ["Pieces <development@pieces.app>"]
+readme = "README.md"
+homepage = "https://pieces.app"
+repository = "https://github.com/pieces-app/cli-agent"
+keywords = ["copilot", "pieces", "ai", "snippets", "materials"]
+packages = [{ include = "pieces", from = "src" }]
+license = "MIT"
+include = [
+    { path = "src/pieces/completions/*", format = ["sdist", "wheel"] }
+]
+
+
+[tool.ruff]
+lint.ignore = [
+  "E501", # Line too long
+]
+
+[tool.poetry.dependencies]
+python = ">=3.11,<3.14"
+pyperclip = ">=1.8.2"
+prompt-toolkit = "^3.0.43"
+rich = "^13.7.1"
+platformdirs = "^4.2.0"
+pyyaml = "^6.0.2"
+mcp = "1.8.0"
+
+## POS dependencies
+urllib3 = ">= 1.25.3"
+python-dateutil = ">=2.8.2"
+aenum = ">=3.1.11"
+websocket-client = "^1.8.0"
+
+[tool.poetry.group.dev.dependencies]
+pytest = "^8.0.0"
+pyinstaller = "^6.13.0"
+requests = "^2.31.0"
+pytest-asyncio = "^1.0.0"
+
+[build-system]
+requires = ["poetry-core>=1.0.0"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.poetry.scripts]
+pieces = "pieces.app:main"

pieces_cli-1.1.0/src/pieces/__init__.py

@@ -0,0 +1 @@
+__version__ = '1.1.0'

pieces_cli-1.1.0/src/pieces/__main__.py

@@ -0,0 +1,10 @@
+# To be able to use
+# python -m pieces [command] [args]
+from pieces.app import main
+import sys
+from pathlib import Path
+
+sys.path.insert(0, str(Path(__file__).parent.parent))
+
+if __name__ == '__main__':
+    main()

pieces_cli-1.1.0/src/pieces/_vendor/pieces_os_client/__init__.py

@@ -0,0 +1,24 @@
+# coding: utf-8
+
+# flake8: noqa
+
+"""
+    Pieces Isomorphic OpenAPI
+
+    Endpoints for Assets, Formats, Users, Asset, Format, User.
+
+    The version of the OpenAPI document: 1.0
+    Contact: tsavo@pieces.app
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+__version__ = "4.4.0"
+
+# import apis into sdk package
+
+# import ApiClient
+
+# import models into sdk package

pieces_cli-1.1.0/src/pieces/_vendor/pieces_os_client/api/__init__.py

@@ -0,0 +1 @@
+