https://github.com/devflowinc/trieve-cli
https://github.com/devflowinc/trieve-cli
Last synced: 7 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/devflowinc/trieve-cli
- Owner: devflowinc
- Created: 2024-03-24T20:07:47.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-14T16:55:40.000Z (over 1 year ago)
- Last Synced: 2025-06-21T05:50:36.922Z (7 months ago)
- Language: Rust
- Size: 181 KB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Trieve CLI - README
## Overview
Trieve CLI is a command-line interface (CLI) for interacting with the Trieve Search Product. It allows users to configure profiles, manage API keys, handle datasets, and interact with organizations directly from the command line.
## Installation
To install the Trieve CLI, you need to have Rust installed on your machine. If you don't already have it installed, you can install it with:
```sh
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
```
Then, you can install the CLI from Cargo:
```sh
cargo install trieve
```
After building the project, you can run the CLI using the `trieve` command.
## Usage
To use the Trieve CLI, you need to configure it with your credentials first.
```sh
trieve login
```
Then, you can use any of the available commands to interact with the Trieve service.
## Setting Configuration via Environment Variables
You can configure the Trieve CLI using environment variables. This is especially useful for CI environments where you want to avoid interactive configuration.
To configure the Trieve CLI using environment variables, set the following environment variables and run the desired command:
- **TRIEVE_NO_PROFILE=true**
- **TRIEVE_API_KEY=your_api_key**
- **TRIEVE_ORG_ID=your_organization_id**
- **TRIEVE_API_URL=your_api_url** (optional, defaults to https://api.trieve.ai)
#### Example:
```sh
TRIEVE_NO_PROFILE=true TRIEVE_API_KEY=api_key TRIEVE_ORG_ID=org_id trieve dataset list
```
With this configuration, you can skip the trieve login step and directly use the CLI commands.
## Features
### General
- **Profile Management**: Switch, delete, and list profiles for different configurations.
- **API Key Management**: Generate new API keys for accessing the Trieve service.
- **Dataset Management**: Create, list, delete, and add seed data to datasets.
- **Organization Management**: Switch between different organizations.
### Commands
#### General Structure
```sh
trieve [subcommand] [flags]
```
NOTE: All of these commands are interactive and will work even without passing in the flags.
#### Commands and Subcommands
1. **Login**
```sh
trieve login --api-key [--api-url ] [--profile-name ]
```
Configures the Trieve CLI with your API key.
2. **Dataset**
```sh
trieve dataset [flags]
```
- **Create**
```sh
trieve dataset create --name
```
Creates a dataset in the Trieve service.
- **List**
```sh
trieve dataset list
```
Lists all datasets in the Trieve service.
- **Delete**
```sh
trieve dataset delete --dataset-id
```
Deletes a dataset in the Trieve service.
- **Example (Add Seed Data)**
```sh
trieve dataset example --dataset-id
```
Adds seed data to a dataset in the Trieve service.
3. **API Key**
```sh
trieve apikey [flags]
```
- **Generate**
```sh
trieve apikey generate --name --role
```
Generates a new API key.
4. **Profile**
```sh
trieve profile [flags]
```
- **Switch**
```sh
trieve profile switch --profile-name
```
Switches to a different profile.
- **Delete**
```sh
trieve profile delete --profile-name
```
Deletes a profile.
- **List**
```sh
trieve profile list
```
Lists all profiles.
5. **Organization**
```sh
trieve organization [flags]
```
- **Switch**
```sh
trieve organization switch --organization-id
```
Switches to a different organization.
## Contributing
Contributions are welcome! Please fork the repository and submit a pull request with your changes.
## License
This project is licensed under the MIT License. See the LICENSE file for details.
## Contact
For any questions or issues, please open an issue on the GitHub repository or contact the maintainers.
---
This README provides a basic overview of the Trieve CLI and its features. For detailed usage and examples, please refer to the command-specific help by running `trieve --help`.