Skip to content

docs: add sk installation instructions #589

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
alizain wants to merge 1 commit into
base: main
Choose a base branch
from
+27 −0
Open

docs: add sk installation instructions #589

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -275,6 +275,15 @@ Add to Claude Desktop config (`~/Library/Application Support/Claude/claude_deskt
}
```

### Option 3: sk (Universal Skills Manager)

Install via [sk](https://github.com/803/skills-supply), the universal package manager for AI agent skills (supports Claude, Codex, OpenCode, Amp, and other compatible agents).

```bash
sk pkg add github dgunning/edgartools --path edgar/ai/skills
sk sync
```

See [AI Integration Guide](docs/ai-integration.md) for complete documentation.

</details>
Expand Down
9 changes: 9 additions & 0 deletions docs/ai-integration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -379,6 +379,15 @@ Exported skills include:
- YAML frontmatter for tool integration
- Helper function documentation

#### Install with `sk`

Install via [sk](https://github.com/803/skills-supply), the universal package manager for AI agent skills (supports Claude, Codex, OpenCode, Amp, and other compatible agents).

```bash
sk pkg add github dgunning/edgartools --path edgar/ai/skills
sk sync
```

## Model Context Protocol (MCP) Server

Run EdgarTools as an MCP server for Claude Desktop and other MCP clients.
Expand Down
9 changes: 9 additions & 0 deletions edgar/ai/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,15 @@ cp -r edgar/ai/skills/core ~/.claude/skills/edgartools/
# Restart Claude Desktop - skill automatically discovered
```

**Install with `sk`:**

Install via [sk](https://github.com/803/skills-supply), the universal package manager for AI agent skills (supports Claude, Codex, OpenCode, Amp, and other compatible agents).

```bash
sk pkg add github dgunning/edgartools --path edgar/ai/skills
sk sync
```

### Usage Example

Once installed, agents can read documentation and write code:
Expand Down