optiondesk 0.3.0__tar.gz

optiondesk-0.3.0/AGENTS.md

@@ -0,0 +1,60 @@
+# Option desk, instructions for Codex
+
+This file is generated by tools/gen_runtime_docs.py from the SKILL.md files under skills/. Edit those, not this file.
+
+The same capabilities are also exposed over MCP by `optiondesk-mcp`, which is the preferred path when the runtime supports it. The command line below is the fallback.
+
+## The skills, which you load yourself
+
+They are not copied into this file. You discover skills in `.agents/skills`, scanning from the working directory up to the repository root, and read a skill's body only once you have selected it. Here `.agents/skills` resolves to `skills/`, so all of these are already available to you:
+
+- `desk-setup`
+- `options-backtest`
+- `options-greeks`
+- `options-positioning`
+- `options-simulation`
+- `options-strategy`
+
+Compiling their bodies into this file as well would add about 44 KB to every session, relevant or not, which is the cost progressive disclosure exists to avoid. Read the one you need from `.agents/skills/<name>/SKILL.md`. That path is relative to the repository root, where you resolve it, not to this file.
+
+## What else is here
+
+The skills listed above are the knowledge. The capabilities they describe are reachable four other ways, all calling the same commands: the command line (`optiondesk --help`), the MCP server (`optiondesk-mcp`), the LangChain bindings in the optional `optiondesk-agent` package, and a bounded LangGraph routine in that same package (`open_desk`).
+
+Two commands are shaped for repetition rather than a single answer. `/desk-watch` refreshes an underlying and reports only material change. `/desk-complete` drives the artifact set to completeness against six criteria that can be checked without judgement. LOOPS.md at the repository root explains when to use each and what makes a poor loop here.
+
+Full catalogue in docs/CAPABILITIES.md, generated public API in docs/INVENTORY.md, install paths in INSTALL.md.
+
+## Command reference
+
+Every command the CLI exposes, read from the argparse parsers in src/optiondesk/cli/ when this file was generated, so it cannot name a command that does not exist or miss one that does. Flags are listed, not explained: run `optiondesk <command> --help` for the detail of any one of them.
+
+- `optiondesk chain SYMBOL`: retrieve an option chain snapshot
+  Flags: --from-file, --data-source, --accept-data-rights, --expiry, --provider, --rate, --dividend-yield, --out-dir
+- `optiondesk greeks`: full Greek ladder from a snapshot
+  Flags: --snapshot, --band, --type, --out-dir
+- `optiondesk strategy [NAME]`: build a multi-leg strategy from a snapshot
+  Flags: --snapshot, --far-snapshot, --kind, --offset, --size, --underlying-entry, --list, --recommend, --vol-view, --owns-underlying, --direction-unknown, --out-dir
+- `optiondesk exposure`: dealer gamma, walls, max pain and smile geometry
+  Flags: --snapshot, --multiplier, --out-dir
+- `optiondesk plots SYMBOL`: write chat-ready market and Greek PNG plots
+  Flags: --snapshot, --from-file, --data-source, --accept-data-rights, --expiry, --rate, --dividend-yield, --band, --out-dir
+- `optiondesk expiries [SYMBOL]`: list available expiries and what is on disk
+  Flags: --provider, --out-dir
+- `optiondesk compare`: every structure side by side, ranked
+  Flags: --snapshot, --size, --include-underlying, --far-snapshot, --rebuild, --out-dir
+- `optiondesk simulate SYMBOL`: GARCH-t posterior, forward paths and tail risk
+  Flags: --horizon, --paths, --draws, --burn, --chains, --period, --provider, --no-structures, --out-dir
+- `optiondesk backtest SYMBOL STRATEGY`: run a structure across real history, modelled premiums
+  Flags: --holding-days, --entry-every, --lookback, --period, --rate, --dividend-yield, --size, --provider, --out-dir
+- `optiondesk forward {open,mark,close,status}`: paper ledger: open, mark, close, status
+  Flags: --plan, --strategy, --underlying, --id, --price, --thesis, --out-dir
+- `optiondesk keys [{list,set,unset,path}] [PROVIDER]`: see, set or locate provider credentials
+  Flags: --value
+- `optiondesk doctor`: report engine, provider and credential status
+- `optiondesk dashboard`: serve the local dashboard
+  Flags: --host, --port, --out-dir
+
+## Standing rules for every runtime
+
+Report the `degraded` flag and its reason before any number when it is true. Never substitute a default implied volatility for a contract that has none; those contracts are skipped and counted on purpose. Option premiums are model values from delayed third-party data, not tradable quotes. Nothing here is investment advice, a recommendation or a solicitation. See DISCLAIMER.md at the repository root.