-
Notifications
You must be signed in to change notification settings - Fork 0
Installation
Guide home | First walkthrough
Install individual skills covers Codex, ChatGPT, Claude chat, and Claude Code.
It includes manual, shell, npx, and browser-upload routes.
Choose the calculation location first. A plugin or skill installation does not always install the local tools.
| You want | Install | Then do this |
|---|---|---|
| A local dashboard and CLI | First walkthrough | Import the supplied sample. |
| Local tools connected to agents | Run ./install.sh from a checkout |
Run optiondesk doctor, then restart the agent. |
| Claude Code skills, commands, and reviewers | Install the tools, then the local plugin | Claude Code instructions. |
| Codex skills and MCP tools | Install the tools, then the local plugin | Codex instructions. |
| Tools in a browser agent | Connect the hosted MCP service | Hosted instructions. |
| Skill instructions alone | Use the skills CLI | Connect tools separately for calculations. |
On macOS or Linux, run these commands from the repository root:
./install.sh --dry-run
./install.shThe installer creates an environment under ~/.optiondesk and command links under ~/.local/bin.
It copies skills to the user skill directories and registers MCP with supported runtime CLIs it finds.
The installer can ask about provider access. Imported files need no provider acknowledgment.
If your terminal cannot find optiondesk, add the command directory for this terminal:
export PATH="$HOME/.local/bin:$PATH"
optiondesk doctorRestart your agent after installation so it can discover the tools.
The installation reference covers custom paths, flags, Docker, and removal.
To remove the installation later, run ./install.sh --uninstall from the checkout with the same custom paths. Your artifacts stay in place.
run.sh installs missing tools, selects expiries, runs the analytics, and opens the dashboard.
It uses external data and also creates a paper position.
Inspect its plan first:
./run.sh --symbols SPY --dry-runIf you have already acknowledged the provider terms, run:
./run.sh --symbols SPYFor an explicit acknowledgment, read the terms linked by ./run.sh --help, then use its --accept-yahoo-terms flag.
The flag grants no public display or redistribution rights.
The default demo directory is ~/TradingDesk/option-desk-demo.
Alpha Vantage history needs a key. Store it with optiondesk keys set alphavantage, which prompts without echoing the value.
./run.sh --help also lists --port, --weeklies, --no-dashboard, --no-open, and --with-tests.
For a shorter first run, omit the history calculations:
./run.sh --symbols SPY --no-simulation --no-backtestsnpx skills add https://github.com/Iman/agent-driven-options-desk-and-skills/tree/main/shell/skills --list
npx skills add https://github.com/Iman/agent-driven-options-desk-and-skills/tree/main/shell/skillsSelect the skills and agent in the install prompt. Skills describe the workflows. They need the CLI or MCP tools to produce calculations.
Next: Run the sample walkthrough or connect your agent.
Guide home · Examples · Troubleshooting · Repository
Research software. Source available for noncommercial use. Read the license and disclaimer.