Package Exports
- @opes-app/cli
- @opes-app/cli/dist/index.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@opes-app/cli) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
@opes-app/cli
AI-powered financial CLI for the Opes platform. Manage your finances directly from the terminal.
Features
- AI Chat Interface - Ask questions about your finances in natural language
- Data Browser - View accounts, transactions, categories, crypto wallets
- Interactive Mode - Full-featured terminal UI powered by OpenTUI
- Settings - Customize theme, colors, and preferences
- Secure Authentication - JWT-based login with secure credential storage
Requirements
- Bun >= 1.0.0
Installation
Via Bun (recommended)
bun install -g @opes-app/cliVia standalone binary (no dependencies)
Download the latest binary for your platform from GitHub Releases:
# macOS (Apple Silicon)
curl -fsSL https://github.com/opes-app/opes/releases/latest/download/opes-darwin-arm64 -o opes
chmod +x opes
sudo mv opes /usr/local/bin/
# macOS (Intel)
curl -fsSL https://github.com/opes-app/opes/releases/latest/download/opes-darwin-x64 -o opes
chmod +x opes
sudo mv opes /usr/local/bin/
# Linux (x64)
curl -fsSL https://github.com/opes-app/opes/releases/latest/download/opes-linux-x64 -o opes
chmod +x opes
sudo mv opes /usr/local/bin/
# Linux (ARM64)
curl -fsSL https://github.com/opes-app/opes/releases/latest/download/opes-linux-arm64 -o opes
chmod +x opes
sudo mv opes /usr/local/bin/Usage
opes # Start interactive mode
opes login # Force browser re-authentication (device flow)
opes --local # Connect to localhost:3001/v1 (development API)
opes --prod # Connect to api.opes.app/v1 (production API)
opes --help # Show helpNavigation
| Key | Action |
|---|---|
Tab |
Switch between tabs |
Up/Down |
Navigate list items |
Enter |
Select / Confirm |
Esc |
Go back / Cancel |
? |
Show keyboard hints |
Chat Commands
Use these commands inside the chat input:
| Command | Behavior |
|---|---|
/new |
Start a new local chat session (server history is preserved) |
/history <query> |
Search previous chat history in keyword mode |
/history --limit <n> <query> |
Same search with custom result limit (1-20) |
/history --hybrid <query> |
Deferred in CLI for now (embedding source prerequisite) |
The assistant also applies balanced auto-retrieval for explicit memory-follow-up prompts and injects bounded snippets into context when triggered.
Configuration
Settings are stored in ~/.opes/settings.json:
- Theme (dark/light)
- Highlight color
- Default currency
- Date format
- Keyboard hints visibility
Server Mode
The CLI can connect to either local development server or production:
# Use local server for this session
opes --local
# Use production server for this session
opes --prodDefault server mode is saved in settings and persists between sessions.
Development
# Clone the repository
git clone https://github.com/opes-app/opes.git
cd opes/apps/cli
# Install dependencies
bun install
# Run in development mode
bun run dev
# Build
bun run build
# Run tests
bun testMigration from v1
If you're upgrading from CLI v1 (Ink-based):
- CLI v2 requires Bun instead of Node.js
- Or use standalone binaries (no runtime required)
- Settings location remains
~/.opes/ - Authentication tokens are preserved
License
MIT - see LICENSE for details.