kuzco-cli/README.md

70 lines
1.5 KiB
Markdown

# Kuzco CLI
Welcome to Kuzco CLI, a sleek Node.js-based interface for interacting with Kuzco, a decentralized network of GPU miners dedicated to processing AI prompts.
## Features
- **Send AI Prompts**: Easily send prompts to be processed by the network.
- **Decentralized Processing**: Take advantage of a network of GPU miners.
## Getting Started
### Prerequisites
- Node.js installed on your machine.
### Installation
1. Clone this repository and navigate into the directory:
```bash
git clone https://git.deadzone.lol/Wizzard/kuzco-cli.git
cd kuzco-cli/cli
```
2. Install the necessary Node.js dependencies:
```bash
npm install
```
3. Installing the GUI:
```bash
cd kuzco-cli/gui
```
4. Install the necessary Node.js dependencies:
```bash
npm install
```
### Configuration
On first run, you'll be prompted to enter your API key for accessing Kuzco's network. This is stored securely and ensures your interactions are authenticated.
### Usage
Run Kuzco CLI with:
```bash
cd kuzco-cli/cli
node kuzco-cli.js
```
Run Kuzco GUI with:
```bash
cd kuzco-cli/gui
electron19 kuzco-gui.js
```
Follow the on-screen prompts to send your AI prompts to the network.
## Prebuilt Binaries
You can download prebuilt versions of this application from the [GitHub Actions page](https://github.com/CODJointOps/kuzco-cli/actions).
## Contributing
Your contributions are welcome!
## License
Kuzco CLI is released under the MIT license. Feel free to use, modify, and distribute it as you see fit.