# InvestSkill
**Professional investment analysis frameworks for US stocks — works on every AI platform**
[](LICENSE)
[](https://github.com/yennanliu/InvestSkill/stargazers)
[](https://github.com/yennanliu/InvestSkill/releases)
[](https://github.com/yennanliu/InvestSkill/actions)
[Documentation](https://yennanliu.github.io/InvestSkill/) · [Cookbook](https://yennanliu.github.io/InvestSkill/cookbook.html) · [繁體中文](README-zh-TW.md)
---
## What is InvestSkill?
InvestSkill is a collection of **21 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.
```
Ask your AI: "Evaluate AAPL using the stock-eval framework"
Get back: Piotroski score · ROIC · moat rating · buy/hold/sell signal
```
---
## Quick Start
**Claude Code** — recommended, full slash-command support:
```bash
claude
/plugin marketplace add yennanliu/InvestSkill
/plugin install us-stock-analysis
/us-stock-analysis:stock-eval AAPL
```
**Cursor / Copilot / Gemini CLI** — clone once, use everywhere:
```bash
git clone https://github.com/yennanliu/InvestSkill.git
cd InvestSkill
# Cursor
cursor .
# → @prompts/stock-eval.md Evaluate Apple
# Gemini CLI
gemini
# → @prompts/stock-eval.md Evaluate Apple
# Any LLM — paste the prompt file directly
cat prompts/stock-eval.md | pbcopy
```
> Full platform guides: [Claude Code](README-claude-code.md) · [Cursor](README-cursor.md) · [Gemini CLI](README-gemini.md)
---
## The 21 Frameworks
### Core Stock Analysis
| Skill | What it produces |
|-------|-----------------|
| `stock-eval` | Piotroski F-Score, ROIC, quality rating, go/no-go signal |
| `fundamental-analysis` | Income statement, balance sheet, cash flow deep dive |
| `technical-analysis` | Chart patterns, MA/RSI/MACD, support & resistance levels |
| `dcf-valuation` | DCF intrinsic value, WACC sensitivity, bear/base/bull scenarios |
| `stock-valuation` | P/E · P/S · EV/EBITDA · comparable company multiples |
| `economics-analysis` | Macro indicators, recession probability, rate sensitivity |
### Financial Reports
| Skill | What it produces |
|-------|-----------------|
| `financial-report-analyst` | 10-K / 10-Q key findings, red flags, accounting quality |
| `earnings-call-analysis` | Management tone, guidance delta, hidden risks |
### Market Monitoring
| Skill | What it produces |
|-------|-----------------|
| `insider-trading` | SEC Form 4 patterns, net buy/sell sentiment |
| `institutional-ownership` | 13F holdings changes, smart money flows |
| `dividend-analysis` | Payout safety score, yield trap detection |
| `short-interest` | Short ratio, days-to-cover, squeeze probability |
### Advanced Research
| Skill | What it produces |
|-------|-----------------|
| `competitor-analysis` | Moat score, Porter's Five Forces, market share |
| `options-analysis` | Greeks, IV rank, earnings play strategy selection |
| `portfolio-review` | Allocation health, concentration risk, rebalancing plan |
| `sector-analysis` | Sector rotation signals, relative strength |
### Meta & Output
| Skill | What it produces |
|-------|-----------------|
| `research-bundle` | Chains all frameworks into one unified investment thesis |
| `full-report` | Runs all 15 modules and saves a standalone HTML report |
| `report-generator` | Converts any analysis into a professional HTML/PDF report |
| `chart-master` | Mermaid · ASCII · Chart.js visualizations from financial data |
| `result-validator` | Scores any analysis on data quality, methodology, and signal consistency |
---
## Example Workflows
**5-minute stock screen**
```
/stock-eval NVDA
/stock-eval AMD
→ Piotroski scores + quality rating for quick go/no-go
```
**Complete due diligence**
```
/stock-eval AAPL
/fundamental-analysis AAPL
/stock-valuation AAPL --methods all
/competitor-analysis AAPL
/financial-report-analyst AAPL 10-K
→ Full investment thesis in one session
```
**Earnings season playbook**
```
/fundamental-analysis TICKER ← pre-earnings baseline
/earnings-call-analysis TICKER ← post-earnings [paste transcript]
/options-analysis TICKER --earnings ← vol expectations + strategy
→ Complete earnings thesis
```
**Export a professional report**
```
/full-report AAPL
→ Saves output/AAPL_report_2026-05-12.html
(hero header · metric cards · interactive Chart.js · signal block)
```
---
## Output Format
Every skill ends with a standardized **Investment Signal Block**:
```
╔══════════════════════════════════════════════╗
║ INVESTMENT SIGNAL ║
╠══════════════════════════════════════════════╣
║ Signal: BULLISH / NEUTRAL / BEARISH ║
║ Confidence: HIGH / MEDIUM / LOW ║
║ Horizon: SHORT / MEDIUM / LONG-TERM ║
║ Score: X.X / 10 ║
╠══════════════════════════════════════════════╣
║ Action: BUY / HOLD / SELL ║
║ Conviction: STRONG / MODERATE / WEAK ║
╚══════════════════════════════════════════════╝
```
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.
---
## Platform Support
| Platform | Setup | How it works |
|----------|-------|-------------|
| **Claude Code** | Marketplace install | 21 native slash commands |
| **Cursor IDE** | Clone repo, open folder | Auto-loads `.cursor/rules/` |
| **Gemini CLI** | Clone repo, `cd` into it | Auto-loads `GEMINI.md` |
| **GitHub Copilot** | Clone repo, open in VS Code | Auto-loads `.github/copilot-instructions.md` |
| **ChatGPT / Claude.ai** | Paste any `prompts/*.md` file | Works in any chat interface |
| **Any other LLM** | Reference or paste prompt files | Platform-agnostic markdown |
---
## Documentation
| Resource | Description |
|----------|-------------|
| [Live Docs Site](https://yennanliu.github.io/InvestSkill/) | Full documentation with dark-theme UI |
| [Cookbook](https://yennanliu.github.io/InvestSkill/cookbook.html) | Walkthrough examples and use cases |
| [Claude Code Guide](README-claude-code.md) | Plugin install + all slash commands |
| [Cursor Guide](README-cursor.md) | Auto-loading rules + `@prompts/` usage |
| [Gemini CLI Guide](README-gemini.md) | File references + multi-framework chains |
| [Adding Skills](ADDING-NEW-SKILLS.md) | 12-step contributor walkthrough |
| [FAQ](FAQ.md) | 50+ answers covering all platforms |
| [Changelog](CHANGELOG.md) | Version history |
---
## Contributing
See [ADDING-NEW-SKILLS.md](ADDING-NEW-SKILLS.md) for the full process. The short version:
1. Create `plugins/us-stock-analysis/skills//SKILL.md` with YAML frontmatter
2. Create `prompts/.md` — same content, no frontmatter, AI-agnostic syntax
3. Add to `plugin.json` skills array and bump version in both manifest files
4. Run `npm test` — all 288+ tests must pass
[Open an issue](https://github.com/yennanliu/InvestSkill/issues) to report bugs · [Start a discussion](https://github.com/yennanliu/InvestSkill/discussions) to propose features.
---
**Version:** 1.6.0 · **Skills:** 21 · **Platforms:** 6 · **License:** MIT · **Tests:** 288+ passing
---
*For educational and research purposes only. Not financial advice.*
*Always consult a qualified financial advisor before making investment decisions.*