Quick Start

Get started with Copinance OS in 5 minutes.

Your First Analysis

1. Search for a Stock

copinance stock search "Apple"

This will show you matching stocks with their symbols.

2. Run a Static Workflow

copinance analyze stock AAPL --timeframe mid_term

This performs a comprehensive stock workflow with:

Current market quote
Historical price data
Fundamental analysis
Key metrics and trends

3. View Results

The results are displayed in the terminal with:

Stock information
Current quote
Price trends
Fundamental metrics
Analysis summary

Using Agentic Workflows

For AI-powered analysis, you need to set up a Gemini API key first.

1. Get API Key

Go to Google AI Studio
Sign in and create an API key
Copy the key

2. Configure

Create a .env file in your project root:

COPINANCEOS_GEMINI_API_KEY=your-api-key-here

3. Ask a Question

copinance ask "What is the current price and P/E ratio?" --symbol AAPL

The AI will analyze the stock and answer your question using available data.

Working with Profiles

Profiles let you customize analysis output based on your financial literacy level.

Automatic Profile Prompting

When you run analyze or ask without a profile, the system will automatically prompt you to set your financial literacy level for more personalized results. You can:

Choose to create a profile with your literacy level (beginner, intermediate, or advanced)
Decline and continue with default settings

Create a Profile Manually

You can also create a profile manually:

copinance profile create --literacy intermediate --name "My Profile"

Use Profile in Analysis

copinance analyze stock AAPL --profile-id <profile-id>

Or simply use your current profile (set with profile set-current).

Common Workflows

Quick Analysis

# Static workflow (no API key needed)
copinance analyze stock AAPL --timeframe mid_term
 
# Agentic workflow (requires API key)
copinance ask "Analyze this stock for me" --symbol AAPL

Data and Cache

All CLI data (profiles, cache, stock search, and workflow results in .copinance/results/) is stored under the .copinance folder. Use copinance cache info to see cache location and copinance cache clear to clear cached data.

Macro Regime Dashboard

Get a comprehensive view of market conditions and macroeconomic indicators:

# Full analysis with defaults (SPY, 252 days, all indicators)
copinance analyze macro
 
# Custom index and lookback period
copinance analyze macro --market-index QQQ --lookback-days 180
 
# Macro-only: exclude market/volatility/sector (VIX, breadth, sector rotation) to focus on economic indicators
copinance analyze macro \
  --no-include-vix \
  --no-include-market-breadth \
  --no-include-sector-rotation
 
# All indicator groups are on by default. Use --no-include-<name> to exclude any (e.g. --no-include-vix). See Workflows for the full list.

See Workflows for all customization options.

Next Steps

CLI Reference - Complete command guide
Workflows - Understanding workflow types
Configuration - Advanced configuration

Installation CLI Reference