Quick Start

Run a few CLI commands to see deterministic analysis (fixed pipelines) and optional question-driven analysis (LLM + tools). The CLI uses the same container and orchestration stack as the library; nothing here is “LLM-only”—quotes and metrics come from data providers and tools.

You can also run a standalone research question at the root (no analyze subcommand): copinance "Your question here" uses the full tool suite with default macro-style market context—see CLI — Natural language at the root.

Your First Analysis

1. Search for an Instrument

# Search for instruments by display name; returns symbols and matches
copinance market search "Apple"

This shows matching market instruments and their symbols.

2. Run an Equity Analysis

# Run deterministic equity analysis (quote, history, fundamentals, summary)
copinance analyze equity AAPL --timeframe mid_term

This performs a comprehensive equity analysis with:

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

3. Check a Live Quote

# Get current price, volume, and other quote data for a symbol
copinance market quote AAPL

This returns the latest quote snapshot for the selected instrument.

4. Explore the Options Market

# Fetch options chain for an underlying (calls/puts, IV, open interest)
copinance market options AAPL --expiration 2026-06-19
 
# Multiple expiries (repeat --expiration / -e)
copinance market options AAPL -e 2026-06-19 -e 2026-09-18

This fetches an options chain snapshot with contract prices, implied volatility, open interest, and volume.

5. Analyze with a Question

# Question-driven analysis: the model uses tools to answer (equity or options context)
copinance analyze equity AAPL --question "What is the current price and P/E ratio?"
copinance analyze options AAPL --question "How is the options chain positioned?"
 
# With SEC/EDGAR configured, you can ask about public filings, filings history, or comparisons
copinance analyze equity AAPL --question "What recent 10-K and 10-Q filings exist and what are the accession numbers?"
copinance analyze equity MSFT --question "How does Microsoft’s headline revenue compare to Apple’s over recent periods?"

The model analyzes the selected context using registered tools (market data, fundamentals, regime/macro, and SEC tools when available). Use --question and pick analyze equity, analyze options, or analyze macro. See CLI — Question-driven examples for more ideas.

Working with Profiles

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

Automatic Profile Prompting

When you run analyze 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

# Create an analysis profile with literacy level and optional display name
copinance profile create --literacy intermediate --name "My Profile"

Use Profile in Analysis

# Run analysis using a specific profile (replace <profile-id> with actual ID)
copinance analyze equity AAPL --profile-id <profile-id>

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

Common Analyses

Quick Analysis

# Deterministic equity analysis (fixed pipeline); options; question-driven (equity/options)
copinance analyze equity AAPL --timeframe mid_term
 
# Deterministic options analysis
copinance analyze options AAPL --expiration 2026-06-19
 
# Multiple expiries (repeat --expiration / -e per date)
copinance analyze options AAPL -e 2026-06-19 -e 2026-09-18
 
# Question-driven analysis (equity)
copinance analyze equity AAPL --question "Analyze this equity for me"
 
# Question-driven analysis (options)
copinance analyze options AAPL --question "What's the put/call open interest?" --expiration 2026-06-19

Data and Cache

All CLI data is stored under .copinance using versioned subdirectories such as data/v2, cache/v2, results/v2, and state/v2. Use copinance cache info to see the active cache location and copinance cache clear to clear cached data.

Macro Regime Dashboard

Get a comprehensive view of market conditions and macroeconomic indicators:

# Full macro/market regime analysis (defaults: SPY, 252-day lookback)
copinance analyze macro
 
# Custom index and lookback period (QQQ = reference; sector ETFs + VIX still fetched)
copinance analyze macro --market-index QQQ --lookback-days 180

--market-index sets the reference index; VIX and the 11 S&P sector ETFs are always used for breadth and rotation. See CLI Reference — Macro + Market Regime for details and Analysis Modes for all options.

Next Steps

CLI Reference - Complete command guide
Analysis Modes - Understanding analysis modes
Configuration — API keys and options

Installation Configuration