@v587d/capital-generation 2.6.5 β 2.7.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +92 -0
- package/LICENSE +1 -1
- package/README.md +83 -30
- package/THIRD_PARTY_NOTICES.md +51 -0
- package/capital-config/client.js +58 -2
- package/capital-config/client.src.cjs +482 -27
- package/capital-config/index.js +177 -4
- package/capital-config/package.json +1 -1
- package/capital-watchlist/client.js +48 -7
- package/capital-watchlist/client.src.cjs +383 -66
- package/capital-watchlist/holding-rules.js +64 -0
- package/capital-watchlist/index.js +117 -2
- package/capital-watchlist/package.json +2 -1
- package/chart-ui/package.json +1 -1
- package/lib/agents/selected-skills-provider.d.ts +26 -0
- package/lib/agents/selected-skills-provider.js +99 -0
- package/lib/index.d.ts +13 -0
- package/lib/index.js +35 -11
- package/lib/time/tools.d.ts +6 -0
- package/lib/time/tools.js +6 -1
- package/lib/watchlist/tools.d.ts +52 -0
- package/lib/watchlist/tools.js +146 -0
- package/lib/web-retriever/local-fetch.d.ts +1 -1
- package/lib/web-retriever/local-fetch.js +1 -1
- package/lib/web-retriever/wind-client.d.ts +1 -1
- package/lib/web-retriever/wind-client.js +1 -1
- package/package.json +13 -3
- package/preset/capital-generation/agent.patch.yml +7 -0
- package/preset/capital-generation/skills/capital-equity-research/SKILL.md +45 -0
- package/preset/capital-generation/skills/capital-event-impact/SKILL.md +29 -0
- package/preset/capital-generation/skills/capital-portfolio-review/SKILL.md +29 -0
- package/selected-skills/InvestSkill/ADDING-NEW-SKILLS.md +546 -0
- package/selected-skills/InvestSkill/CHANGELOG.md +373 -0
- package/selected-skills/InvestSkill/CI-CD-GUIDE.md +432 -0
- package/selected-skills/InvestSkill/CLAUDE.md +148 -0
- package/selected-skills/InvestSkill/CONTRIBUTING.md +291 -0
- package/selected-skills/InvestSkill/DEPLOYMENTS.md +321 -0
- package/selected-skills/InvestSkill/FAQ.md +509 -0
- package/selected-skills/InvestSkill/GEMINI.md +419 -0
- package/selected-skills/InvestSkill/LICENSE +21 -0
- package/selected-skills/InvestSkill/PLATFORM-COMPATIBILITY.md +529 -0
- package/selected-skills/InvestSkill/README-claude-code.md +435 -0
- package/selected-skills/InvestSkill/README-cursor.md +475 -0
- package/selected-skills/InvestSkill/README-gemini.md +532 -0
- package/selected-skills/InvestSkill/README-ollama.md +106 -0
- package/selected-skills/InvestSkill/README-zh-TW.md +461 -0
- package/selected-skills/InvestSkill/README.md +311 -0
- package/selected-skills/InvestSkill/RELEASE-QUICK-REFERENCE.md +230 -0
- package/selected-skills/InvestSkill/RELEASE_NOTES.md +121 -0
- package/selected-skills/InvestSkill/SECURITY.md +232 -0
- package/selected-skills/InvestSkill/TODO.md +28 -0
- package/selected-skills/InvestSkill/UPSTREAM.md +62 -0
- package/selected-skills/InvestSkill/install.sh +212 -0
- package/selected-skills/InvestSkill/package.json +64 -0
- package/selected-skills/InvestSkill/plugins/us-stock-analysis/README.md +119 -0
- package/selected-skills/InvestSkill/plugins/us-stock-analysis/skills/10k-digest/SKILL.md +338 -0
- package/selected-skills/InvestSkill/plugins/us-stock-analysis/skills/bear-case/SKILL.md +233 -0
- package/selected-skills/InvestSkill/plugins/us-stock-analysis/skills/catalyst-calendar/SKILL.md +327 -0
- package/selected-skills/InvestSkill/plugins/us-stock-analysis/skills/chart-master/SKILL.md +648 -0
- package/selected-skills/InvestSkill/plugins/us-stock-analysis/skills/competitor-analysis/SKILL.md +478 -0
- package/selected-skills/InvestSkill/plugins/us-stock-analysis/skills/dcf-valuation/SKILL.md +109 -0
- package/selected-skills/InvestSkill/plugins/us-stock-analysis/skills/dividend-analysis/SKILL.md +684 -0
- package/selected-skills/InvestSkill/plugins/us-stock-analysis/skills/earnings-call-analysis/SKILL.md +456 -0
- package/selected-skills/InvestSkill/plugins/us-stock-analysis/skills/earnings-preview/SKILL.md +277 -0
- package/selected-skills/InvestSkill/plugins/us-stock-analysis/skills/economics-analysis/SKILL.md +349 -0
- package/selected-skills/InvestSkill/plugins/us-stock-analysis/skills/etf-analysis/SKILL.md +279 -0
- package/selected-skills/InvestSkill/plugins/us-stock-analysis/skills/fact-check/SKILL.md +288 -0
- package/selected-skills/InvestSkill/plugins/us-stock-analysis/skills/financial-report-analyst/SKILL.md +544 -0
- package/selected-skills/InvestSkill/plugins/us-stock-analysis/skills/full-report/SKILL.md +301 -0
- package/selected-skills/InvestSkill/plugins/us-stock-analysis/skills/fundamental-analysis/SKILL.md +67 -0
- package/selected-skills/InvestSkill/plugins/us-stock-analysis/skills/industry-map/SKILL.md +336 -0
- package/selected-skills/InvestSkill/plugins/us-stock-analysis/skills/insider-trading/SKILL.md +502 -0
- package/selected-skills/InvestSkill/plugins/us-stock-analysis/skills/institutional-ownership/SKILL.md +548 -0
- package/selected-skills/InvestSkill/plugins/us-stock-analysis/skills/learning-coach/SKILL.md +311 -0
- package/selected-skills/InvestSkill/plugins/us-stock-analysis/skills/options-analysis/SKILL.md +495 -0
- package/selected-skills/InvestSkill/plugins/us-stock-analysis/skills/portfolio-review/SKILL.md +465 -0
- package/selected-skills/InvestSkill/plugins/us-stock-analysis/skills/position-ladder/SKILL.md +429 -0
- package/selected-skills/InvestSkill/plugins/us-stock-analysis/skills/report-generator/SKILL.md +857 -0
- package/selected-skills/InvestSkill/plugins/us-stock-analysis/skills/research-bundle/SKILL.md +94 -0
- package/selected-skills/InvestSkill/plugins/us-stock-analysis/skills/result-validator/SKILL.md +174 -0
- package/selected-skills/InvestSkill/plugins/us-stock-analysis/skills/risk-stress-test/SKILL.md +293 -0
- package/selected-skills/InvestSkill/plugins/us-stock-analysis/skills/sector-analysis/SKILL.md +426 -0
- package/selected-skills/InvestSkill/plugins/us-stock-analysis/skills/short-interest/SKILL.md +397 -0
- package/selected-skills/InvestSkill/plugins/us-stock-analysis/skills/stock-eval/SKILL.md +645 -0
- package/selected-skills/InvestSkill/plugins/us-stock-analysis/skills/stock-screener/SKILL.md +244 -0
- package/selected-skills/InvestSkill/plugins/us-stock-analysis/skills/stock-valuation/SKILL.md +640 -0
- package/selected-skills/InvestSkill/plugins/us-stock-analysis/skills/tax-lens/SKILL.md +351 -0
- package/selected-skills/InvestSkill/plugins/us-stock-analysis/skills/technical-analysis/SKILL.md +654 -0
- package/selected-skills/InvestSkill/plugins/us-stock-analysis/skills/thesis-tracker/SKILL.md +317 -0
- package/selected-skills/README.md +54 -0
- package/selected-skills/catalog.js +733 -0
- package/selected-skills/china-stock-research-skills/.github/ISSUE_TEMPLATE/bug_report.md +35 -0
- package/selected-skills/china-stock-research-skills/.github/ISSUE_TEMPLATE/skill_request.md +28 -0
- package/selected-skills/china-stock-research-skills/.github/PULL_REQUEST_TEMPLATE.md +15 -0
- package/selected-skills/china-stock-research-skills/CHANGELOG.md +59 -0
- package/selected-skills/china-stock-research-skills/CONTRIBUTING.md +121 -0
- package/selected-skills/china-stock-research-skills/GITHUB_PUBLISHING.md +259 -0
- package/selected-skills/china-stock-research-skills/INSTALL.md +151 -0
- package/selected-skills/china-stock-research-skills/LICENSE +21 -0
- package/selected-skills/china-stock-research-skills/PUBLISH_CHECKLIST.md +165 -0
- package/selected-skills/china-stock-research-skills/README.en.md +209 -0
- package/selected-skills/china-stock-research-skills/README.md +209 -0
- package/selected-skills/china-stock-research-skills/RELEASE_ASSETS.md +222 -0
- package/selected-skills/china-stock-research-skills/ROADMAP.md +45 -0
- package/selected-skills/china-stock-research-skills/SKILLS.md +85 -0
- package/selected-skills/china-stock-research-skills/UPSTREAM.md +11 -0
- package/selected-skills/china-stock-research-skills/examples/full-report-flow.md +20 -0
- package/selected-skills/china-stock-research-skills/examples/module-select-cases.md +26 -0
- package/selected-skills/china-stock-research-skills/examples/quickstart-prompts.md +25 -0
- package/selected-skills/china-stock-research-skills/skills/business-decomposition-order-quality/SKILL.md +55 -0
- package/selected-skills/china-stock-research-skills/skills/business-decomposition-order-quality/references/idc-order-ledger-guide.md +34 -0
- package/selected-skills/china-stock-research-skills/skills/business-decomposition-order-quality/references/order-quality-checklist.md +16 -0
- package/selected-skills/china-stock-research-skills/skills/china-stock-research-orchestrator/SKILL.md +75 -0
- package/selected-skills/china-stock-research-skills/skills/china-stock-research-orchestrator/references/final-output-contract.md +62 -0
- package/selected-skills/china-stock-research-skills/skills/china-stock-research-orchestrator/references/routing-matrix.md +34 -0
- package/selected-skills/china-stock-research-skills/skills/china-stock-research-orchestrator/references/sector-overlay-escalation-rules.md +38 -0
- package/selected-skills/china-stock-research-skills/skills/financial-health/SKILL.md +54 -0
- package/selected-skills/china-stock-research-skills/skills/financial-health/references/idc-balance-sheet-stress-guide.md +31 -0
- package/selected-skills/china-stock-research-skills/skills/financial-health/references/red-flag-checklist.md +14 -0
- package/selected-skills/china-stock-research-skills/skills/industry-competition-moat/SKILL.md +54 -0
- package/selected-skills/china-stock-research-skills/skills/industry-competition-moat/references/idc-value-chain-and-peers.md +42 -0
- package/selected-skills/china-stock-research-skills/skills/industry-competition-moat/references/moat-grid.md +13 -0
- package/selected-skills/china-stock-research-skills/skills/risk-warning-catalysts/SKILL.md +54 -0
- package/selected-skills/china-stock-research-skills/skills/risk-warning-catalysts/references/idc-monitoring-indicators.md +33 -0
- package/selected-skills/china-stock-research-skills/skills/risk-warning-catalysts/references/monitoring-dashboard.md +25 -0
- package/selected-skills/china-stock-research-skills/skills/shared/references/analysis-pattern-selector.md +24 -0
- package/selected-skills/china-stock-research-skills/skills/shared/references/asset-heavy-ramp-overlay.md +28 -0
- package/selected-skills/china-stock-research-skills/skills/shared/references/business-model-transition-overlay.md +28 -0
- package/selected-skills/china-stock-research-skills/skills/shared/references/citation-standard.md +48 -0
- package/selected-skills/china-stock-research-skills/skills/shared/references/company-disclosure-map.md +37 -0
- package/selected-skills/china-stock-research-skills/skills/shared/references/consumer-channel-brand-overlay.md +29 -0
- package/selected-skills/china-stock-research-skills/skills/shared/references/cyclical-price-driven-overlay.md +29 -0
- package/selected-skills/china-stock-research-skills/skills/shared/references/export-manufacturing-supply-chain-overlay.md +29 -0
- package/selected-skills/china-stock-research-skills/skills/shared/references/financial-kpi-dictionary.md +43 -0
- package/selected-skills/china-stock-research-skills/skills/shared/references/idc-heavy-asset-transition-overlay.md +73 -0
- package/selected-skills/china-stock-research-skills/skills/shared/references/language-output-standard.md +36 -0
- package/selected-skills/china-stock-research-skills/skills/shared/references/project-order-business-overlay.md +28 -0
- package/selected-skills/china-stock-research-skills/skills/shared/references/regulated-healthcare-policy-overlay.md +29 -0
- package/selected-skills/china-stock-research-skills/skills/shared/references/research-output-template.md +50 -0
- package/selected-skills/china-stock-research-skills/skills/shared/references/sector-adaptation-checklist.md +42 -0
- package/selected-skills/china-stock-research-skills/skills/shared/references/source-registry.md +49 -0
- package/selected-skills/china-stock-research-skills/skills/shared/templates/catalyst-calendar.md +5 -0
- package/selected-skills/china-stock-research-skills/skills/shared/templates/company-fact-sheet.md +25 -0
- package/selected-skills/china-stock-research-skills/skills/shared/templates/evidence-table.md +5 -0
- package/selected-skills/china-stock-research-skills/skills/shared/templates/idc-project-ledger.md +5 -0
- package/selected-skills/china-stock-research-skills/skills/shared/templates/valuation-scenario-table.md +7 -0
- package/selected-skills/china-stock-research-skills/skills/strategy-business-transition/SKILL.md +55 -0
- package/selected-skills/china-stock-research-skills/skills/strategy-business-transition/references/idc-transition-markers.md +27 -0
- package/selected-skills/china-stock-research-skills/skills/strategy-business-transition/references/transition-scorecard.md +13 -0
- package/selected-skills/china-stock-research-skills/skills/valuation-investment-strategy/SKILL.md +55 -0
- package/selected-skills/china-stock-research-skills/skills/valuation-investment-strategy/references/idc-valuation-overlays.md +31 -0
- package/selected-skills/china-stock-research-skills/skills/valuation-investment-strategy/references/method-selection.md +14 -0
- package/selected-skills/investment-skills/.github/workflows/validate.yml +25 -0
- package/selected-skills/investment-skills/.tbd/config.yml +107 -0
- package/selected-skills/investment-skills/LICENSE +21 -0
- package/selected-skills/investment-skills/Makefile +29 -0
- package/selected-skills/investment-skills/README.md +253 -0
- package/selected-skills/investment-skills/UPSTREAM.md +12 -0
- package/selected-skills/investment-skills/docs/development.md +37 -0
- package/selected-skills/investment-skills/docs/roadmap.md +25 -0
- package/selected-skills/investment-skills/skills/buffett-investment-framework/SKILL.md +192 -0
- package/selected-skills/investment-skills/skills/buffett-investment-framework/agents/openai.yaml +4 -0
- package/selected-skills/investment-skills/skills/buffett-investment-framework/references/00-source-key.md +82 -0
- package/selected-skills/investment-skills/skills/buffett-investment-framework/references/01-decision-posture.md +242 -0
- package/selected-skills/investment-skills/skills/buffett-investment-framework/references/02-business-economics.md +188 -0
- package/selected-skills/investment-skills/skills/buffett-investment-framework/references/03-management-governance.md +213 -0
- package/selected-skills/investment-skills/skills/buffett-investment-framework/references/04-financial-reality.md +192 -0
- package/selected-skills/investment-skills/skills/buffett-investment-framework/references/05-valuation.md +166 -0
- package/selected-skills/investment-skills/skills/buffett-investment-framework/references/06-capital-allocation.md +238 -0
- package/selected-skills/investment-skills/skills/buffett-investment-framework/references/07-risk-monitoring.md +189 -0
- package/selected-skills/investment-skills/skills/buffett-investment-framework/references/08-specialized-overlays.md +309 -0
- package/selected-skills/investment-skills/skills/buffett-investment-framework/scripts/framework.py +470 -0
|
@@ -0,0 +1,311 @@
|
|
|
1
|
+
<div align="center">
|
|
2
|
+
|
|
3
|
+
# InvestSkill
|
|
4
|
+
|
|
5
|
+
**Professional investment analysis frameworks for US stocks β works on every AI platform**
|
|
6
|
+
|
|
7
|
+
**No API keys Β· No subscriptions Β· 100% free**
|
|
8
|
+
|
|
9
|
+
[](#no-api-keys-no-cost)
|
|
10
|
+
[](LICENSE)
|
|
11
|
+
[](https://github.com/yennanliu/InvestSkill/stargazers)
|
|
12
|
+
[](https://github.com/yennanliu/InvestSkill/releases)
|
|
13
|
+
[](https://github.com/yennanliu/InvestSkill/actions)
|
|
14
|
+
|
|
15
|
+
[Documentation](https://yennanliu.github.io/InvestSkill/) Β· [Learn Investing](https://yennanliu.github.io/InvestSkill/learning.html) Β· [Cookbook](https://yennanliu.github.io/InvestSkill/cookbook.html) Β· [ηΉι«δΈζ](README-zh-TW.md)
|
|
16
|
+
|
|
17
|
+
</div>
|
|
18
|
+
|
|
19
|
+
---
|
|
20
|
+
|
|
21
|
+
## What is InvestSkill?
|
|
22
|
+
|
|
23
|
+
InvestSkill is a collection of **30 structured analysis frameworks** that turn any AI assistant into an institutional-quality investment analyst. There is no runtime β every skill is a prompt that works in Claude Code, Cursor, Gemini CLI, GitHub Copilot, ChatGPT, or any other LLM.
|
|
24
|
+
|
|
25
|
+
**Nothing to sign up for, nothing to pay for.** No API key, no data-vendor subscription, no billing setup β you bring the AI assistant you already use (a free tier or a local model works too) and InvestSkill is just markdown. See [No API keys, no cost](#no-api-keys-no-cost).
|
|
26
|
+
|
|
27
|
+
```
|
|
28
|
+
Ask your AI: "Evaluate AAPL using the stock-eval framework"
|
|
29
|
+
Get back: Piotroski score Β· ROIC Β· moat rating Β· buy/hold/sell signal
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
<div class="home-card">
|
|
33
|
+
<span class="home-card-icon">π</span>
|
|
34
|
+
<div class="home-card-body">
|
|
35
|
+
<div class="home-card-title">New to investing? Start with the Learning guide</div>
|
|
36
|
+
<p>A thirteen-lesson field guide, in plain English and Traditional Chinese: Part I teaches the concepts behind every skill β reading a balance sheet, valuing a business, holding a portfolio β and Part II the practical foundations: accounts and orders, an ETF core, taxes (including for non-US investors), earnings season, and the psychology that protects the plan. No finance degree required.</p>
|
|
37
|
+
<p><a class="home-card-cta" href="https://yennanliu.github.io/InvestSkill/learning.html">Start learning β</a></p>
|
|
38
|
+
</div>
|
|
39
|
+
</div>
|
|
40
|
+
|
|
41
|
+
---
|
|
42
|
+
|
|
43
|
+
## Quick Start
|
|
44
|
+
|
|
45
|
+
**One command, any AI agent** β [pick yours on the website](https://yennj12.js.org/InvestSkill/#install):
|
|
46
|
+
|
|
47
|
+
```bash
|
|
48
|
+
# Claude Code
|
|
49
|
+
curl -fsSL https://raw.githubusercontent.com/yennanliu/InvestSkill/main/install.sh | bash -s -- -a claude
|
|
50
|
+
|
|
51
|
+
# Swap the agent: cursor Β· copilot Β· gemini Β· codex Β· opencode Β· any
|
|
52
|
+
curl -fsSL https://raw.githubusercontent.com/yennanliu/InvestSkill/main/install.sh | bash -s -- -a cursor
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
The installer copies every framework into `.investskill/prompts/` and wires up your agent's own entry point β nothing else runs on your machine:
|
|
56
|
+
|
|
57
|
+
| `-a` | Agent | Wires up |
|
|
58
|
+
|------|-------|----------|
|
|
59
|
+
| `claude` | Claude Code | `.claude/skills/<skill>/SKILL.md` (slash commands) |
|
|
60
|
+
| `cursor` | Cursor | `.cursor/rules/investskill.mdc` |
|
|
61
|
+
| `copilot` | GitHub Copilot | `.github/copilot-instructions.md` |
|
|
62
|
+
| `gemini` | Gemini CLI | `GEMINI.md` |
|
|
63
|
+
| `codex` | Codex | `AGENTS.md` |
|
|
64
|
+
| `opencode` | OpenCode | `AGENTS.md` |
|
|
65
|
+
| `any` | ChatGPT, Claude.ai, Ollama, β¦ | `.investskill/prompts/` only β paste and go |
|
|
66
|
+
|
|
67
|
+
Add `-g` to install for your user instead of one project, `-d DIR` to target another directory, or `-h` for all options. Existing instruction files are appended to, never overwritten, and re-running is a no-op. Read it first if you'd rather not pipe to `bash`: [install.sh](install.sh).
|
|
68
|
+
|
|
69
|
+
**Claude Code via the plugin marketplace** β full slash-command support:
|
|
70
|
+
```bash
|
|
71
|
+
claude
|
|
72
|
+
/plugin marketplace add yennanliu/InvestSkill
|
|
73
|
+
/plugin install us-stock-analysis
|
|
74
|
+
/us-stock-analysis:stock-eval AAPL
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
**Or clone the repo** β every framework in `prompts/`, use it anywhere:
|
|
78
|
+
```bash
|
|
79
|
+
git clone https://github.com/yennanliu/InvestSkill.git
|
|
80
|
+
cd InvestSkill
|
|
81
|
+
|
|
82
|
+
# Cursor
|
|
83
|
+
cursor .
|
|
84
|
+
# β @prompts/stock-eval.md Evaluate Apple
|
|
85
|
+
|
|
86
|
+
# Gemini CLI
|
|
87
|
+
gemini
|
|
88
|
+
# β @prompts/stock-eval.md Evaluate Apple
|
|
89
|
+
|
|
90
|
+
# Any LLM β paste the prompt file directly
|
|
91
|
+
cat prompts/stock-eval.md | pbcopy
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
> Full platform guides: [Claude Code](README-claude-code.md) Β· [Cursor](README-cursor.md) Β· [Gemini CLI](README-gemini.md) Β· [Ollama](README-ollama.md)
|
|
95
|
+
|
|
96
|
+
---
|
|
97
|
+
|
|
98
|
+
## No API Keys, No Cost
|
|
99
|
+
|
|
100
|
+
InvestSkill is **completely free to use** β there is nothing to buy, register, or configure.
|
|
101
|
+
|
|
102
|
+
| | |
|
|
103
|
+
|---|---|
|
|
104
|
+
| **API keys** | **None.** No OpenAI / Anthropic / Alpha Vantage / Polygon key. The plugin never calls an endpoint β there is no code to call one with. |
|
|
105
|
+
| **Subscriptions** | **None.** No paid tier, no seats, no usage metering, no account. |
|
|
106
|
+
| **Market-data fees** | **None.** No Bloomberg, no paid data feed. The AI reads public filings and free sources β or you paste the numbers in yourself. |
|
|
107
|
+
| **Install / runtime** | **None.** Every skill is a plain markdown prompt. Nothing runs on your machine, so nothing phones home. |
|
|
108
|
+
| **License** | **MIT.** Free to use, fork, and modify β for personal or commercial work. |
|
|
109
|
+
|
|
110
|
+
**The only thing you need is an AI assistant you already have.** That can be a paid plan (Claude Code, Cursor, Copilot), a free tier (ChatGPT, Gemini, Claude.ai), or a fully offline local model via [Ollama](README-ollama.md) β in which case the total cost of running every framework is literally zero.
|
|
111
|
+
|
|
112
|
+
> Because there's no API, there's also no telemetry: InvestSkill never sees your tickers, your holdings, or your analysis. See [Data & Accuracy](site/content/DATA-AND-ACCURACY.md) for where the numbers actually come from.
|
|
113
|
+
|
|
114
|
+
**Bring your own data.** The filing skills (`10k-digest`, `financial-report-analyst`, `fact-check`) carry a keyless SEC EDGAR recipe a tool-enabled assistant can follow by itself. If yours can't browse, two optional zero-dependency scripts fetch the primary source for you to paste β `node scripts/fetch-edgar.js AAPL --form 10-K` saves the filing as text, `node scripts/fetch-fundamentals.js AAPL` builds a reconciled statement pack from the SEC's XBRL facts. Neither is part of the plugin. Details on the [Data & Accuracy](site/content/DATA-AND-ACCURACY.md#bring-your-own-data-the-keyless-edgar-path) page.
|
|
115
|
+
|
|
116
|
+
---
|
|
117
|
+
|
|
118
|
+
## The 30 Frameworks
|
|
119
|
+
|
|
120
|
+
### Core Stock Analysis
|
|
121
|
+
|
|
122
|
+
| Skill | What it produces |
|
|
123
|
+
|-------|-----------------|
|
|
124
|
+
| `stock-eval` | Piotroski F-Score, ROIC, quality rating, go/no-go signal |
|
|
125
|
+
| `technical-analysis` | MA chart (30/60/90/200/365d) with trade entry/target/stop, chart patterns, RSI/MACD, MTF alignment, Ichimoku |
|
|
126
|
+
| `stock-valuation` | P/E Β· P/S Β· EV/EBITDA Β· comparable company multiples |
|
|
127
|
+
| `economics-analysis` | Macro indicators, recession probability, rate sensitivity |
|
|
128
|
+
|
|
129
|
+
### Financial Reports
|
|
130
|
+
|
|
131
|
+
| Skill | What it produces |
|
|
132
|
+
|-------|-----------------|
|
|
133
|
+
| `financial-report-analyst` | 10-K / 10-Q key findings, red flags, accounting quality |
|
|
134
|
+
| `10k-digest` | Structured markdown digest β abstract, section summaries, metrics table, refs (EN / ηΉδΈ) |
|
|
135
|
+
| `earnings-call-analysis` | Management tone, guidance delta, hidden risks |
|
|
136
|
+
|
|
137
|
+
### Market Monitoring
|
|
138
|
+
|
|
139
|
+
| Skill | What it produces |
|
|
140
|
+
|-------|-----------------|
|
|
141
|
+
| `insider-trading` | SEC Form 4 patterns, net buy/sell sentiment |
|
|
142
|
+
| `institutional-ownership` | 13F holdings changes, smart money flows |
|
|
143
|
+
| `dividend-analysis` | Payout safety score, yield trap detection |
|
|
144
|
+
| `short-interest` | Short ratio, days-to-cover, squeeze probability |
|
|
145
|
+
|
|
146
|
+
### Advanced Research
|
|
147
|
+
|
|
148
|
+
| Skill | What it produces |
|
|
149
|
+
|-------|-----------------|
|
|
150
|
+
| `competitor-analysis` | Moat score, Porter's Five Forces, market share |
|
|
151
|
+
| `industry-map` | Supply/value-chain graph (upstreamβdownstream), chokepoints, margin-pool migration, second-order ideas |
|
|
152
|
+
| `options-analysis` | Greeks, IV rank, earnings play strategy selection |
|
|
153
|
+
| `portfolio-review` | Allocation health, concentration risk scoring, correlation analysis, tax-loss harvesting, rebalancing plan |
|
|
154
|
+
| `sector-analysis` | Sector rotation signals, valuation tables, seasonality calendar, momentum scoring |
|
|
155
|
+
| `stock-screener` | Multi-ticker ranking across valuation, quality, momentum, sentiment, and growth; leaderboard + top picks + avoid list |
|
|
156
|
+
| `catalyst-calendar` | Forward-looking 90-day event calendar: earnings, macro events, catalysts, impact scoring, event-driven strategies |
|
|
157
|
+
| `bear-case` | Deliberate short-seller red-team: bear thesis, accounting red flags, downside target, thesis-killers (counterevidence for any bull thesis) |
|
|
158
|
+
| `position-ladder` | Staged entry ladder + trim/re-add cycle for a single holding: share-count floor/ceiling, blended cost basis, wash-sale flags, total-return-vs-buy-and-hold check, thesis-break gate |
|
|
159
|
+
| `thesis-tracker` | Write, save, and re-check an investment thesis β KPIs with thresholds, invalidation triggers, catalysts, a pre-mortem, and a decision log; `--update` re-reads the saved file against new data and returns INTACT / WEAKENED / BROKEN |
|
|
160
|
+
| `etf-analysis` | ETF / index-fund due diligence β expense ratio vs. category, tracking difference, liquidity, holdings concentration and tilt, overlap with your other positions, distribution and capital-gains history, structure warnings, and an ETF-vs-top-holdings comparison, scored as an ETF Fitness Score 0β10 |
|
|
161
|
+
| `earnings-preview` | The before-earnings skill β consensus vs. whisper, 8-quarter beat rate and post-print move distribution, options-implied vs. realized move, what the current price already assumes, the KPIs to watch, and a three-scenario grid (beat-and-raise / beat-and-lower / miss) with expected reaction and a position rule for each |
|
|
162
|
+
| `tax-lens` | US tax mechanics for a position or portfolio β short- vs. long-term treatment, wash-sale window check, qualified-dividend holding-period test, lot selection (specific-ID vs. FIFO), tax-loss-harvesting pairs, account placement, estimated annual tax drag β plus a --non-us module (W-8BEN, dividend withholding and treaty rates, capital-gains treatment, US estate-tax exposure, UCITS alternatives). Educational only, never tax advice |
|
|
163
|
+
| `risk-stress-test` | Portfolio and position risk report β beta-weighted exposure, historical scenario replay (2008, March 2020, 2022 rate shock, 2025 tariff shock), parametric VaR / CVaR at 95 / 99 %, max-drawdown estimate, correlation-spike scenario, rate / USD / oil sensitivity, liquidity (days to exit at 20 % of ADV), and a Risk Budget Score 0β10 |
|
|
164
|
+
|
|
165
|
+
### Meta & Output
|
|
166
|
+
|
|
167
|
+
| Skill | What it produces |
|
|
168
|
+
|-------|-----------------|
|
|
169
|
+
| `full-report` | Runs all 15 modules and saves a standalone HTML report |
|
|
170
|
+
| `report-generator` | Converts any analysis into a professional HTML/PDF report |
|
|
171
|
+
| `chart-master` | Mermaid Β· ASCII Β· Chart.js visualizations from financial data |
|
|
172
|
+
| `result-validator` | Scores any analysis on data quality, methodology, and signal consistency |
|
|
173
|
+
| `learning-coach` | Explains any InvestSkill output like a mentor β every metric in plain words, why it matters, its good / bad range, and the lesson that teaches it β then asks 3β5 Socratic questions and "what would change your mind?". --level beginner / intermediate, --lang zh-TW, and a --quiz mode that drills a Learning lesson |
|
|
174
|
+
| `fact-check` | Claim-level verification of any report or data set β extract every figure and factual claim, check each against a primary source (SEC filing, company IR, FRED, exchange data, or the user's own document), recompute derived numbers, mark β
verified / β οΈ mismatch / β unverifiable, and re-issue the report with inline citations and a References section; Verification Score 0β10 |
|
|
175
|
+
|
|
176
|
+
### Aliases (redirects)
|
|
177
|
+
|
|
178
|
+
Three earlier skills were absorbed into larger ones. They are still installed so old references keep working, but they are aliases, not frameworks, and are not counted above.
|
|
179
|
+
|
|
180
|
+
| Alias | Redirects to |
|
|
181
|
+
|-------|--------------|
|
|
182
|
+
| `fundamental-analysis` | `stock-eval` (statement-level deep dive is a section of it) |
|
|
183
|
+
| `dcf-valuation` | `stock-valuation` (DCF is Method 1 of its multi-method model) |
|
|
184
|
+
| `research-bundle` | `full-report` (use `--depth quick / standard / comprehensive`) |
|
|
185
|
+
|
|
186
|
+
---
|
|
187
|
+
|
|
188
|
+
## Example Workflows
|
|
189
|
+
|
|
190
|
+
**5-minute stock screen**
|
|
191
|
+
```
|
|
192
|
+
/stock-eval NVDA
|
|
193
|
+
/stock-eval AMD
|
|
194
|
+
β Piotroski scores + quality rating for quick go/no-go
|
|
195
|
+
```
|
|
196
|
+
|
|
197
|
+
**Complete due diligence**
|
|
198
|
+
```
|
|
199
|
+
/stock-eval AAPL
|
|
200
|
+
/stock-valuation AAPL --methods all
|
|
201
|
+
/competitor-analysis AAPL
|
|
202
|
+
/financial-report-analyst AAPL 10-K
|
|
203
|
+
β Full investment thesis in one session
|
|
204
|
+
```
|
|
205
|
+
|
|
206
|
+
**Earnings season playbook**
|
|
207
|
+
```
|
|
208
|
+
/stock-eval TICKER β pre-earnings baseline
|
|
209
|
+
/earnings-call-analysis TICKER β post-earnings [paste transcript]
|
|
210
|
+
/options-analysis TICKER --earnings β vol expectations + strategy
|
|
211
|
+
β Complete earnings thesis
|
|
212
|
+
```
|
|
213
|
+
|
|
214
|
+
**Export a professional report**
|
|
215
|
+
```
|
|
216
|
+
/full-report AAPL
|
|
217
|
+
β Saves output/AAPL_report_2026-05-12.html
|
|
218
|
+
(hero header Β· metric cards Β· interactive Chart.js Β· signal block)
|
|
219
|
+
```
|
|
220
|
+
|
|
221
|
+
---
|
|
222
|
+
|
|
223
|
+
## Output Format
|
|
224
|
+
|
|
225
|
+
Every skill ends with a standardized **Investment Signal Block**:
|
|
226
|
+
|
|
227
|
+
```
|
|
228
|
+
ββββββββββββββββββββββββββββββββββββββββββββββββ
|
|
229
|
+
β INVESTMENT SIGNAL β
|
|
230
|
+
β βββββββββββββββββββββββββββββββββββββββββββββββ£
|
|
231
|
+
β Signal: BULLISH / NEUTRAL / BEARISH β
|
|
232
|
+
β Confidence: HIGH / MEDIUM / LOW β
|
|
233
|
+
β Horizon: SHORT / MEDIUM / LONG-TERM β
|
|
234
|
+
β Score: X.X / 10 β
|
|
235
|
+
β βββββββββββββββββββββββββββββββββββββββββββββββ£
|
|
236
|
+
β Action: BUY / HOLD / SELL β
|
|
237
|
+
β Conviction: STRONG / MODERATE / WEAK β
|
|
238
|
+
ββββββββββββββββββββββββββββββββββββββββββββββββ
|
|
239
|
+
```
|
|
240
|
+
|
|
241
|
+
HTML reports render this as a styled dark panel with a score progress bar, ghost watermark text, and a teal/sky gradient accent β see [report-generator](prompts/report-generator.md) for the full design system.
|
|
242
|
+
|
|
243
|
+
---
|
|
244
|
+
|
|
245
|
+
## Platform Support
|
|
246
|
+
|
|
247
|
+
| Platform | Setup | How it works |
|
|
248
|
+
|----------|-------|-------------|
|
|
249
|
+
| **Claude Code** | Marketplace install | 34 native slash commands (30 frameworks + 3 aliases + 1 output tool) |
|
|
250
|
+
| **Cursor IDE** | Clone repo, open folder | Auto-loads `.cursor/rules/` |
|
|
251
|
+
| **Gemini CLI** | Clone repo, `cd` into it | Auto-loads `GEMINI.md` |
|
|
252
|
+
| **GitHub Copilot** | Clone repo, open in VS Code | Auto-loads `.github/copilot-instructions.md` |
|
|
253
|
+
| **Ollama (local models)** | Clone repo, run a local model | Offline open-source models, no API key β [guide](README-ollama.md) |
|
|
254
|
+
| **ChatGPT / Claude.ai** | Paste any `prompts/*.md` file | Works in any chat interface |
|
|
255
|
+
| **Any other LLM** | Reference or paste prompt files | Platform-agnostic markdown |
|
|
256
|
+
|
|
257
|
+
---
|
|
258
|
+
|
|
259
|
+
## Learn the Frameworks
|
|
260
|
+
|
|
261
|
+
New to investing, or unsure which skill to reach for? Start here:
|
|
262
|
+
|
|
263
|
+
| Guide | What it gives you |
|
|
264
|
+
|-------|-------------------|
|
|
265
|
+
| [Concepts](site/content/CONCEPTS.md) | The mental models behind the metrics β quality vs. value vs. growth, intrinsic value, moats, risk, and the signal block |
|
|
266
|
+
| [Glossary](site/content/GLOSSARY.md) | Plain-English definitions, formulas, and good/bad ranges for every metric the skills emit |
|
|
267
|
+
| [Choose a Skill](site/content/CHOOSE-A-SKILL.md) | Map your goal to the right framework, plus comparisons of the ones that overlap |
|
|
268
|
+
| [Use Cases](site/content/USE-CASES.md) | End-to-end journeys by investor type β income, first-timer, earnings, macro, skeptic |
|
|
269
|
+
| [Data & Accuracy](site/content/DATA-AND-ACCURACY.md) | Where the numbers come from, how to spot hallucinations, and how to validate output |
|
|
270
|
+
|
|
271
|
+
---
|
|
272
|
+
|
|
273
|
+
## Documentation
|
|
274
|
+
|
|
275
|
+
| Resource | Description |
|
|
276
|
+
|----------|-------------|
|
|
277
|
+
| [Live Docs Site](https://yennanliu.github.io/InvestSkill/) | Full documentation with dark-theme UI |
|
|
278
|
+
| [Cookbook](https://yennanliu.github.io/InvestSkill/cookbook.html) | Walkthrough examples and use cases |
|
|
279
|
+
| [Skill Reference](https://yennanliu.github.io/InvestSkill/skills.html) | All 30 frameworks, one browsable page each |
|
|
280
|
+
| [Claude Code Guide](README-claude-code.md) | Plugin install + all slash commands |
|
|
281
|
+
| [Cursor Guide](README-cursor.md) | Auto-loading rules + `@prompts/` usage |
|
|
282
|
+
| [Gemini CLI Guide](README-gemini.md) | File references + multi-framework chains |
|
|
283
|
+
| [Ollama Guide](README-ollama.md) | Local open-source models, offline & no API key |
|
|
284
|
+
| [Adding Skills](ADDING-NEW-SKILLS.md) | 12-step contributor walkthrough |
|
|
285
|
+
| [FAQ](FAQ.md) | 50+ answers covering all platforms |
|
|
286
|
+
| [Changelog](CHANGELOG.md) | Version history |
|
|
287
|
+
|
|
288
|
+
---
|
|
289
|
+
|
|
290
|
+
## Contributing
|
|
291
|
+
|
|
292
|
+
See [ADDING-NEW-SKILLS.md](ADDING-NEW-SKILLS.md) for the full process. The short version:
|
|
293
|
+
|
|
294
|
+
1. `node scripts/new-skill.js <name> --category <core|reports|monitoring|advanced|meta> --title "β¦" --desc "β¦"` β scaffolds `SKILL.md` with the full output contract and wires the skill into the site, READMEs, cross-AI configs, and CHANGELOG
|
|
295
|
+
2. Write the analysis in `plugins/us-stock-analysis/skills/<name>/SKILL.md`, then `node scripts/sync-prompts.js <name>` β `prompts/<name>.md` is generated from it (skills are auto-discovered; no `plugin.json` change)
|
|
296
|
+
3. Run `npm test` β structure, prompt sync, skill contract, counts, and install script must all pass
|
|
297
|
+
|
|
298
|
+
[Open an issue](https://github.com/yennanliu/InvestSkill/issues) to report bugs Β· [Start a discussion](https://github.com/yennanliu/InvestSkill/discussions) to propose features.
|
|
299
|
+
|
|
300
|
+
---
|
|
301
|
+
|
|
302
|
+
**Version:** 1.12.0 Β· **Frameworks:** 30 analysis frameworks (+ 3 aliases, 1 output tool) Β· **Skills:** 34 Β· **Platforms:** 7 Β· **License:** MIT Β· **Tests:** all passing
|
|
303
|
+
|
|
304
|
+
---
|
|
305
|
+
|
|
306
|
+
<div align="center">
|
|
307
|
+
|
|
308
|
+
*For educational and research purposes only. Not financial advice.*
|
|
309
|
+
*Always consult a qualified financial advisor before making investment decisions.*
|
|
310
|
+
|
|
311
|
+
</div>
|
|
@@ -0,0 +1,230 @@
|
|
|
1
|
+
# InvestSkill Release Quick Reference
|
|
2
|
+
|
|
3
|
+
Fast-track guide for releasing new versions to all platforms.
|
|
4
|
+
|
|
5
|
+
## 30-Second Release
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
# 1. Update version (two files)
|
|
9
|
+
# .claude-plugin/marketplace.json β "version": "X.Y.Z"
|
|
10
|
+
# plugins/us-stock-analysis/.claude-plugin/plugin.json β "version": "X.Y.Z"
|
|
11
|
+
|
|
12
|
+
# 2. Update CHANGELOG.md
|
|
13
|
+
# Add section: ## [X.Y.Z] - YYYY-MM-DD
|
|
14
|
+
|
|
15
|
+
# 3. Commit
|
|
16
|
+
git add .claude-plugin/marketplace.json plugins/us-stock-analysis/.claude-plugin/plugin.json CHANGELOG.md
|
|
17
|
+
git commit -m "chore: bump version to X.Y.Z"
|
|
18
|
+
git push origin main
|
|
19
|
+
|
|
20
|
+
# β
Done! Auto-deploy handles everything else
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
## What Gets Released
|
|
24
|
+
|
|
25
|
+
| Platform | Method | Status |
|
|
26
|
+
|----------|--------|--------|
|
|
27
|
+
| Claude Code | GitHub Release | β
Auto-published |
|
|
28
|
+
| Cursor | Rules packaging | β
Auto-published |
|
|
29
|
+
| Gemini CLI | Prompts packaging | β
Auto-published |
|
|
30
|
+
| Copilot | Repository (.github/) | β
Auto-published |
|
|
31
|
+
| Universal | GitHub artifacts | β
Auto-published |
|
|
32
|
+
|
|
33
|
+
## Release Steps Checklist
|
|
34
|
+
|
|
35
|
+
### Before Release
|
|
36
|
+
- [ ] All features implemented and tested
|
|
37
|
+
- [ ] CHANGELOG.md written with details
|
|
38
|
+
- [ ] README.md updated if needed
|
|
39
|
+
- [ ] Documentation (GEMINI.md, etc.) updated
|
|
40
|
+
- [ ] Tests passing: `npm test`
|
|
41
|
+
- [ ] No uncommitted changes: `git status`
|
|
42
|
+
|
|
43
|
+
### During Release
|
|
44
|
+
- [ ] Update `marketplace.json` version
|
|
45
|
+
- [ ] Update `plugin.json` version
|
|
46
|
+
- [ ] Update `CHANGELOG.md`
|
|
47
|
+
- [ ] Commit changes
|
|
48
|
+
- [ ] Push to main branch
|
|
49
|
+
|
|
50
|
+
### After Release (Automatic)
|
|
51
|
+
- [ ] β
Tests run automatically
|
|
52
|
+
- [ ] β
Version change detected
|
|
53
|
+
- [ ] β
Release artifacts created
|
|
54
|
+
- [ ] β
Published to all 5 platforms
|
|
55
|
+
- [ ] β
DEPLOYMENTS.md updated
|
|
56
|
+
- [ ] β
Release notes generated
|
|
57
|
+
|
|
58
|
+
## Verify Release
|
|
59
|
+
|
|
60
|
+
**Check GitHub Actions**:
|
|
61
|
+
1. Visit: https://github.com/yennanliu/InvestSkill/actions
|
|
62
|
+
2. Click latest "Auto Deploy" workflow
|
|
63
|
+
3. Wait for all jobs to complete (green checkmarks)
|
|
64
|
+
|
|
65
|
+
**Check Release**:
|
|
66
|
+
1. Visit: https://github.com/yennanliu/InvestSkill/releases
|
|
67
|
+
2. Latest release should be: `InvestSkill vX.Y.Z`
|
|
68
|
+
3. Artifacts should include:
|
|
69
|
+
- `invest-skill-marketplace-X.Y.Z.tar.gz`
|
|
70
|
+
- `us-stock-analysis-X.Y.Z.tar.gz`
|
|
71
|
+
- `cursor-rules-X.Y.Z.mdc`
|
|
72
|
+
- `gemini-prompts-X.Y.Z.tar.gz`
|
|
73
|
+
- Platform release notes
|
|
74
|
+
|
|
75
|
+
**Check Deployment Record**:
|
|
76
|
+
1. Visit: [DEPLOYMENTS.md](DEPLOYMENTS.md)
|
|
77
|
+
2. Latest entry should be v**X.Y.Z**
|
|
78
|
+
3. All platforms should show β
|
|
79
|
+
|
|
80
|
+
## Common Version Numbers
|
|
81
|
+
|
|
82
|
+
- **X.Y.0** β Major version (new skills, breaking changes)
|
|
83
|
+
- **X.0.Z** β Minor version (new features)
|
|
84
|
+
- **0.0.Z** β Patch version (bug fixes, documentation)
|
|
85
|
+
|
|
86
|
+
Examples:
|
|
87
|
+
- `1.3.0` β Minor release (new documentation, multi-platform support)
|
|
88
|
+
- `1.2.1` β Patch release (bug fix)
|
|
89
|
+
- `2.0.0` β Major release (major new features or breaking changes)
|
|
90
|
+
|
|
91
|
+
## Semantic Versioning
|
|
92
|
+
|
|
93
|
+
Follow [Semantic Versioning](https://semver.org/):
|
|
94
|
+
|
|
95
|
+
- **Major** (1.0.0 β 2.0.0): Breaking changes
|
|
96
|
+
- Removing skills
|
|
97
|
+
- Changing output format significantly
|
|
98
|
+
- Major architecture changes
|
|
99
|
+
|
|
100
|
+
- **Minor** (1.0.0 β 1.1.0): New features
|
|
101
|
+
- Adding new skills
|
|
102
|
+
- New analysis frameworks
|
|
103
|
+
- New platform support
|
|
104
|
+
|
|
105
|
+
- **Patch** (1.0.0 β 1.0.1): Bug fixes
|
|
106
|
+
- Documentation fixes
|
|
107
|
+
- Small improvements
|
|
108
|
+
- Performance improvements
|
|
109
|
+
|
|
110
|
+
## Version Consistency Check
|
|
111
|
+
|
|
112
|
+
Before pushing:
|
|
113
|
+
|
|
114
|
+
```bash
|
|
115
|
+
# Verify versions match
|
|
116
|
+
jq '.metadata.version' .claude-plugin/marketplace.json
|
|
117
|
+
jq '.version' plugins/us-stock-analysis/.claude-plugin/plugin.json
|
|
118
|
+
|
|
119
|
+
# They must be identical!
|
|
120
|
+
```
|
|
121
|
+
|
|
122
|
+
## Rollback (If Needed)
|
|
123
|
+
|
|
124
|
+
```bash
|
|
125
|
+
# Delete the last tag
|
|
126
|
+
git tag -d vX.Y.Z
|
|
127
|
+
git push origin :refs/tags/vX.Y.Z
|
|
128
|
+
|
|
129
|
+
# Revert version bumps
|
|
130
|
+
git revert HEAD
|
|
131
|
+
|
|
132
|
+
# Or reset to previous commit
|
|
133
|
+
git reset --hard HEAD~1
|
|
134
|
+
git push origin main
|
|
135
|
+
```
|
|
136
|
+
|
|
137
|
+
## Release Notification
|
|
138
|
+
|
|
139
|
+
After release completes, notify:
|
|
140
|
+
|
|
141
|
+
1. **GitHub Issues** β Link to release in pinned issue
|
|
142
|
+
2. **GitHub Discussions** β Post release announcement
|
|
143
|
+
3. **Social Media** β Tweet/share the release
|
|
144
|
+
|
|
145
|
+
Template:
|
|
146
|
+
```
|
|
147
|
+
π InvestSkill vX.Y.Z released!
|
|
148
|
+
|
|
149
|
+
β¨ What's new:
|
|
150
|
+
- Feature 1
|
|
151
|
+
- Feature 2
|
|
152
|
+
- Bug fix 1
|
|
153
|
+
|
|
154
|
+
π¦ Available on:
|
|
155
|
+
β
Claude Code
|
|
156
|
+
β
Cursor
|
|
157
|
+
β
Gemini CLI
|
|
158
|
+
β
GitHub Copilot
|
|
159
|
+
β
Universal prompts
|
|
160
|
+
|
|
161
|
+
π See release notes: [link]
|
|
162
|
+
```
|
|
163
|
+
|
|
164
|
+
## Troubleshooting
|
|
165
|
+
|
|
166
|
+
**Q: Version not detected?**
|
|
167
|
+
```bash
|
|
168
|
+
# Verify version consistency
|
|
169
|
+
jq '.metadata.version' .claude-plugin/marketplace.json
|
|
170
|
+
jq '.version' plugins/us-stock-analysis/.claude-plugin/plugin.json
|
|
171
|
+
```
|
|
172
|
+
|
|
173
|
+
**Q: Tests failing?**
|
|
174
|
+
```bash
|
|
175
|
+
# Run locally
|
|
176
|
+
npm test
|
|
177
|
+
node scripts/test-skills.js
|
|
178
|
+
```
|
|
179
|
+
|
|
180
|
+
**Q: Artifacts not created?**
|
|
181
|
+
```bash
|
|
182
|
+
# Check GitHub Actions logs:
|
|
183
|
+
# https://github.com/yennanliu/InvestSkill/actions
|
|
184
|
+
```
|
|
185
|
+
|
|
186
|
+
**Q: Deployment record missing?**
|
|
187
|
+
```bash
|
|
188
|
+
# Manual update:
|
|
189
|
+
node scripts/record-deploy.js
|
|
190
|
+
```
|
|
191
|
+
|
|
192
|
+
## Script Reference
|
|
193
|
+
|
|
194
|
+
| Script | Purpose | Usage |
|
|
195
|
+
|--------|---------|-------|
|
|
196
|
+
| `scripts/test-skills.js` | Unit tests | `node scripts/test-skills.js` |
|
|
197
|
+
| `scripts/publish-cursor-rules.js` | Cursor publishing | Auto (in CI) |
|
|
198
|
+
| `scripts/publish-gemini.js` | Gemini publishing | Auto (in CI) |
|
|
199
|
+
| `scripts/generate-platform-release-notes.js` | Release notes | Auto (in CI) |
|
|
200
|
+
| `scripts/record-deploy.js` | Deployment record | Auto (in CI) |
|
|
201
|
+
|
|
202
|
+
## Advanced: Enable Registry Publishing
|
|
203
|
+
|
|
204
|
+
To publish directly to platform registries:
|
|
205
|
+
|
|
206
|
+
```bash
|
|
207
|
+
# Add GitHub Secrets:
|
|
208
|
+
CURSOR_REGISTRY_TOKEN=<token>
|
|
209
|
+
GEMINI_REGISTRY_TOKEN=<token>
|
|
210
|
+
GEMINI_REGISTRY_URL=<url>
|
|
211
|
+
|
|
212
|
+
# Then releases publish to registries automatically
|
|
213
|
+
```
|
|
214
|
+
|
|
215
|
+
See [CI-CD-GUIDE.md](CI-CD-GUIDE.md) for details.
|
|
216
|
+
|
|
217
|
+
## Need Help?
|
|
218
|
+
|
|
219
|
+
1. **Read** [CI-CD-GUIDE.md](CI-CD-GUIDE.md) for complete documentation
|
|
220
|
+
2. **Check** GitHub Actions logs
|
|
221
|
+
3. **Review** workflow files in `.github/workflows/`
|
|
222
|
+
4. **Open** an issue on GitHub
|
|
223
|
+
|
|
224
|
+
---
|
|
225
|
+
|
|
226
|
+
**Quick Links**:
|
|
227
|
+
- π [Full CI/CD Guide](CI-CD-GUIDE.md)
|
|
228
|
+
- π [Releases Page](https://github.com/yennanliu/InvestSkill/releases)
|
|
229
|
+
- π [Deployment History](DEPLOYMENTS.md)
|
|
230
|
+
- βοΈ [GitHub Actions](https://github.com/yennanliu/InvestSkill/actions)
|
|
@@ -0,0 +1,121 @@
|
|
|
1
|
+
## InvestSkill v1.12.0
|
|
2
|
+
|
|
3
|
+
**30 Professional Investment Analysis Frameworks** Β· 34 skills Β· 7 platforms Β· no API keys, no runtime, no telemetry
|
|
4
|
+
|
|
5
|
+
Released 2026-09-25. The largest release since 1.0: six new frameworks plus the `fact-check` meta framework, an enforced output contract on every skill, Learning track Part II, a redesigned docs site, a one-command installer for any AI agent, and a keyless SEC EDGAR data path for users whose assistant cannot browse.
|
|
6
|
+
|
|
7
|
+
## What's New
|
|
8
|
+
|
|
9
|
+
**π§ Six new analysis frameworks + `fact-check`** (advertised count 26 β **30**, with `fundamental-analysis` / `dcf-valuation` / `research-bundle` now counted as aliases):
|
|
10
|
+
- `thesis-tracker` β write, save, and re-check an investment thesis; `--update` returns **INTACT / WEAKENED / BROKEN**
|
|
11
|
+
- `etf-analysis` β ETF / index-fund due diligence with an ETF Fitness Score 0β10
|
|
12
|
+
- `earnings-preview` β the *before*-earnings skill: consensus vs. whisper, implied vs. realized move, three-scenario grid with position rules
|
|
13
|
+
- `tax-lens` β holding periods, wash sales, lot selection, harvesting, account placement; `--non-us` module (W-8BEN, withholding, estate tax, UCITS). Educational only
|
|
14
|
+
- `risk-stress-test` β beta-weighted exposure, scenario replay (2008 Β· 2020 Β· 2022 Β· 2025), VaR / CVaR, liquidity; Risk Budget Score 0β10
|
|
15
|
+
- `learning-coach` β explains any InvestSkill output like a mentor; `--quiz <lesson>` drills a Learning lesson
|
|
16
|
+
- `fact-check` β claim-level verification against primary sources, recomputation, and a corrected report with inline citations; Verification Score 0β10 feeds `result-validator`
|
|
17
|
+
|
|
18
|
+
**π Output contract enforced on every analysis skill** β the `Data & Sources` header (As of Β· Source Β· Retrieval Β· Confidence), the Data Verification gate, and a Thesis Invalidation section are now present in all 30 frameworks and checked by `scripts/check-skill-contract.js` in `npm test`.
|
|
19
|
+
|
|
20
|
+
**π Bring your own data β the keyless SEC EDGAR path**
|
|
21
|
+
- `10k-digest`, `financial-report-analyst`, and `fact-check` carry a retrieval recipe a tool-enabled assistant can follow on its own: ticker β CIK β `data.sec.gov` submissions index β filing document β XBRL company facts, with the SEC's User-Agent and rate rules
|
|
22
|
+
- Two optional, zero-dependency helpers for assistants that cannot browse: `node scripts/fetch-edgar.js AAPL --form 10-K` saves a filing as pasteable text; `node scripts/fetch-fundamentals.js AAPL` builds a reconciled statement pack from the XBRL facts. Outside the plugin; covered by a 194-check offline suite in CI
|
|
23
|
+
- New **Bring Your Own Data** section on the Data & Accuracy page (EN + ηΉι«δΈζ)
|
|
24
|
+
|
|
25
|
+
**β‘ One-command install for any AI agent**
|
|
26
|
+
```bash
|
|
27
|
+
curl -fsSL https://raw.githubusercontent.com/yennanliu/InvestSkill/main/install.sh | bash -s -- -a claude # or cursor Β· copilot Β· gemini Β· codex Β· opencode Β· any
|
|
28
|
+
```
|
|
29
|
+
Existing instruction files are appended to, never overwritten; re-running is a no-op. 116 install checks run in CI, including live sandboxed installs.
|
|
30
|
+
|
|
31
|
+
**π Learning track Part II** β Lessons 9β13 (Before Your First Trade Β· ETFs & Index Investing Β· Taxes & Account Types incl. a non-US section Β· Earnings Season Β· Psychology & Process), a "When the Answer Is No" case study, self-check quizzes, and a glossary grown to 76 terms.
|
|
32
|
+
|
|
33
|
+
**π¨ Site redesign** β real landing pages (EN + zh-TW) with an animated terminal demo, a filterable Skill Reference grid, per-skill run boxes, dark mode, keyboard search, and an install picker. New META 10-K deep-dive demo and seven live Cookbook workflow runs.
|
|
34
|
+
|
|
35
|
+
**π οΈ Tooling** β `scripts/sync-prompts.js` (prompts are now generated from `SKILL.md`), `scripts/new-skill.js` scaffolder, `scripts/eval-skills.js` opt-in behavioural eval, shared `signal-block.js` / `skill-registry.js` libraries, and a roadmap with progress tracking.
|
|
36
|
+
|
|
37
|
+
## Quick Start
|
|
38
|
+
|
|
39
|
+
### Claude Code
|
|
40
|
+
```bash
|
|
41
|
+
/plugin marketplace add yennanliu/InvestSkill
|
|
42
|
+
/plugin install us-stock-analysis
|
|
43
|
+
/us-stock-analysis:stock-eval AAPL
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
### Any agent via the installer
|
|
47
|
+
```bash
|
|
48
|
+
curl -fsSL https://raw.githubusercontent.com/yennanliu/InvestSkill/main/install.sh | bash -s -- -a cursor
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
### Cursor
|
|
52
|
+
Rules auto-load in Cursor AI Chat (Cmd+K):
|
|
53
|
+
```
|
|
54
|
+
@prompts/stock-eval.md Evaluate Apple (AAPL)
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
### Gemini CLI
|
|
58
|
+
In project directory:
|
|
59
|
+
```bash
|
|
60
|
+
gemini
|
|
61
|
+
> @prompts/stock-eval.md Evaluate Apple (AAPL)
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
## Platform Availability
|
|
65
|
+
|
|
66
|
+
| Platform | Status | Installation | Documentation |
|
|
67
|
+
|----------|--------|---------------|----------------|
|
|
68
|
+
| Claude Code | β
Available | `/plugin install us-stock-analysis` or `install.sh -a claude` | [README-claude-code.md](README-claude-code.md) |
|
|
69
|
+
| Cursor IDE | β
Available | Auto-loads from `.cursor/rules/invest-skill.mdc` or `install.sh -a cursor` | [README-cursor.md](README-cursor.md) |
|
|
70
|
+
| Gemini CLI | β
Available | Auto-loads from `GEMINI.md` or `install.sh -a gemini` | [README-gemini.md](README-gemini.md) |
|
|
71
|
+
| GitHub Copilot | β
Available | Auto-loads from `.github/copilot-instructions.md` or `install.sh -a copilot` | [README.md](README.md) |
|
|
72
|
+
| Codex / OpenCode | β
Available | `install.sh -a codex` / `-a opencode` (writes `AGENTS.md`) | [README.md](README.md) |
|
|
73
|
+
| Universal (ChatGPT, Claude.ai, Ollama, β¦) | β
Available | `install.sh -a any` or copy prompts from `prompts/` | [README-ollama.md](README-ollama.md) |
|
|
74
|
+
|
|
75
|
+
## Download & Verify
|
|
76
|
+
|
|
77
|
+
All releases include checksums for verification:
|
|
78
|
+
|
|
79
|
+
```bash
|
|
80
|
+
# Download artifacts
|
|
81
|
+
tar xzf invest-skill-marketplace-1.12.0.tar.gz
|
|
82
|
+
|
|
83
|
+
# Verify checksums
|
|
84
|
+
sha256sum -c checksums.txt
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
**Artifacts:**
|
|
88
|
+
- `invest-skill-marketplace-1.12.0.tar.gz` β Full marketplace (all platforms)
|
|
89
|
+
- `us-stock-analysis-1.12.0.tar.gz` β Claude Code plugin only
|
|
90
|
+
- `checksums.txt` β SHA-256 verification file
|
|
91
|
+
|
|
92
|
+
## Full Changelog
|
|
93
|
+
|
|
94
|
+
See [CHANGELOG.md β 1.12.0](CHANGELOG.md#1120---2026-09-25) for every entry, including the review-driven fixes to the EDGAR helpers (filename collisions for same-day filings, `LongTermDebt` double counting, `--limit` validation, 13F-HR routed by manager rather than issuer).
|
|
95
|
+
|
|
96
|
+
**Upgrade notes**
|
|
97
|
+
- No breaking changes. Skill names, the signal block, and the plugin layout are unchanged.
|
|
98
|
+
- `fundamental-analysis`, `dcf-valuation`, and `research-bundle` still work but are aliases; prefer `stock-eval`, `stock-valuation`, and `full-report`.
|
|
99
|
+
- The EDGAR helpers need Node β₯ 18 and, per SEC fair-access rules, `EDGAR_USER_AGENT="Your Name your@email"`.
|
|
100
|
+
- Two stale, unreferenced 10-K PDFs were removed from `data/`; `fetch-edgar.js` reproduces either as text on demand.
|
|
101
|
+
|
|
102
|
+
---
|
|
103
|
+
|
|
104
|
+
## Documentation & Resources
|
|
105
|
+
|
|
106
|
+
- π [Complete README](README.md) β All platforms setup guide
|
|
107
|
+
- π [Documentation site](https://yennanliu.github.io/InvestSkill/) β Skill Reference, Learning track, Cookbook, Data & Accuracy
|
|
108
|
+
- π [Platform Compatibility](PLATFORM-COMPATIBILITY.md) β Feature comparison
|
|
109
|
+
- π [Cookbook](site/content/COOKBOOK.md) β Examples and walkthroughs
|
|
110
|
+
- π§ [CI/CD Guide](CI-CD-GUIDE.md) β Automated release pipeline
|
|
111
|
+
- π‘ [30 Investment Frameworks](prompts/) β Universal prompt files
|
|
112
|
+
|
|
113
|
+
## Support
|
|
114
|
+
|
|
115
|
+
- π [Report Issues](https://github.com/yennanliu/InvestSkill/issues)
|
|
116
|
+
- π¬ [Discussions](https://github.com/yennanliu/InvestSkill/discussions)
|
|
117
|
+
- π§ Feedback: [GitHub Issues](https://github.com/yennanliu/InvestSkill/issues/new)
|
|
118
|
+
|
|
119
|
+
---
|
|
120
|
+
|
|
121
|
+
**Legal:** This toolkit provides educational analysis only and does NOT constitute financial advice. Always consult qualified financial advisors and do your own research.
|