Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Arindam200/PiecesCLI
https://github.com/Arindam200/PiecesCLI
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/Arindam200/PiecesCLI
- Owner: Arindam200
- Created: 2024-06-09T17:08:58.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-06-14T16:08:37.000Z (5 months ago)
- Last Synced: 2024-06-14T17:40:31.332Z (5 months ago)
- Language: JavaScript
- Size: 3.91 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: Readme.md
Awesome Lists containing this project
README
# Pieces CLI
Welcome to Pieces CLI, a command-line interface for interacting with the Pieces OS Client API. This tool allows you to ask questions, get formatted responses, and search Stack Overflow for relevant coding issues.
## Features
- **Interactive Mode**: Engage in an interactive session with the CLI.
- **Formatted Responses**: Get responses with syntax highlighting and formatting.
- **Stack Overflow Search**: Automatically search Stack Overflow for relevant coding issues.
## Installation
To install the Pieces CLI, you need to have Node.js and npm installed on your machine. Then, you can install the CLI globally using npm:
```sh
npm install -g pieces-cli
```
## Usage
You can use the Pieces CLI in two main ways: interactive mode or direct query mode.
### Interactive Mode
To enter interactive mode, use the `-i` or `--interactive` flag:
```sh
npx pieces-cli -i
```
In interactive mode, you can type your queries directly and get immediate responses. You can also use the following commands:
- `exit`: Quit the interactive mode.
- `help`: Display available commands.
- `version`: Display the version number.
- `clear`: Clear the screen.
### Direct Query Mode
You can also provide a query directly as an argument:
```sh
npx pieces-cli "What is the capital of France?"
```
### Options
- `-i, --interactive`: Enter interactive mode.
- `-h, --help`: Display the help message.
- `-v, --version`: Display the version number.
### Examples
```sh
# Ask a question directly
npx pieces-cli "What is the capital of France?"
# Enter interactive mode
npx pieces-cli -i
# Display help message
npx pieces-cli --help
# Display version number
npx pieces-cli --version
```
## Development
If you want to contribute or modify the CLI, follow these steps:
1. Clone the repository:
```sh
git clone https://github.com/yourusername/pieces-cli.git
```
2. Navigate to the project directory:
```sh
cd pieces-cli
```
3. Install dependencies:
```sh
npm install
```
4. Run the CLI locally:
```sh
node index.js
```
## License
This project is licensed under the MIT License.
## Contact
For any questions or issues, please open an issue on the [GitHub repository](https://github.com/yourusername/pieces-cli/issues).