87 lines
1.3 KiB
Markdown
87 lines
1.3 KiB
Markdown
# RevIQ CLI
|
|
|
|
Command-line interface for RevIQ database and user management.
|
|
|
|
## Installation
|
|
|
|
```bash
|
|
# Build the CLI
|
|
bun run build
|
|
|
|
# The compiled binary will be at dist/reviq
|
|
```
|
|
|
|
## Usage
|
|
|
|
```bash
|
|
# Run directly with bun
|
|
bun run cli <command>
|
|
|
|
# Or use the compiled binary
|
|
./dist/reviq <command>
|
|
```
|
|
|
|
## Commands
|
|
|
|
### Authentication
|
|
|
|
```bash
|
|
# Login with an API token
|
|
reviq auth login --token <your-token>
|
|
|
|
# Check authentication status
|
|
reviq auth status
|
|
|
|
# Logout
|
|
reviq auth logout
|
|
```
|
|
|
|
To get an API token:
|
|
1. Log in to the web dashboard
|
|
2. Go to Account Settings > API Tokens
|
|
3. Create a new token and copy it
|
|
|
|
### User Management
|
|
|
|
```bash
|
|
# Create a new user
|
|
reviq user create --email <email>
|
|
|
|
# Confirm email
|
|
reviq user confirm-email --code <code>
|
|
```
|
|
|
|
### Organization Management
|
|
|
|
```bash
|
|
# List organizations
|
|
reviq org list
|
|
|
|
# Create an organization
|
|
reviq org create --name <name> --slug <slug>
|
|
|
|
# Add a site to an organization
|
|
reviq org add-site --org <slug> --domain <domain>
|
|
```
|
|
|
|
### Admin Commands
|
|
|
|
```bash
|
|
# Complete login (admin)
|
|
reviq admin complete-login
|
|
```
|
|
|
|
### Other Commands
|
|
|
|
```bash
|
|
# Bootstrap the database
|
|
reviq bootstrap
|
|
|
|
# Generate shell completions
|
|
reviq completions
|
|
```
|
|
|
|
## Configuration
|
|
|
|
Credentials are stored at `~/.config/reviq/credentials.json`.
|