Skip to content

Commit 604cdd9

Browse files
authored
Add agent skill with install script and documentation (#102)
Introduces the sidemantic-modeler skill for Claude Code and compatible agents. Includes a one-liner installer script and install instructions for both curl and npx/bunx methods.
1 parent e0fcd6e commit 604cdd9

2 files changed

Lines changed: 57 additions & 0 deletions

File tree

README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,26 @@ A universal metrics layer for consistent metrics across your data stack. Compati
99

1010
![Jupyter Widget Preview](preview.png)
1111

12+
## Agent Skill
13+
14+
Sidemantic ships an [agent skill](skills/sidemantic-modeler/) that teaches Claude Code, Codex, and other `SKILL.md`-compatible agents to build, validate, and query semantic models.
15+
16+
**One-liner install (no clone required):**
17+
18+
```bash
19+
curl -fsSL https://raw.githubusercontent.com/sidequery/sidemantic/main/skills/install.sh | bash
20+
```
21+
22+
**npx / bunx:**
23+
24+
```bash
25+
npx skills add https://github.com/sidequery/sidemantic --skill sidemantic-modeler
26+
# or
27+
bunx skills add https://github.com/sidequery/sidemantic --skill sidemantic-modeler
28+
```
29+
30+
The installer downloads the skill to `~/.agents/skills/sidemantic-modeler` and symlinks it into `~/.claude/skills/`.
31+
1232
## How mature is Sidemantic?
1333

1434
Sidemantic is a very ambitious and young semantic layer project. You may encounter rough patches, especially with the more exotic features like converting between semantic model formats or serving semantic layers via the included Postgres protocol server.

skills/install.sh

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
#!/usr/bin/env bash
2+
set -euo pipefail
3+
4+
SKILL_NAME="sidemantic-modeler"
5+
REPO="sidequery/sidemantic"
6+
BRANCH="main"
7+
REMOTE_DIR="skills/$SKILL_NAME"
8+
BASE_URL="https://raw.githubusercontent.com/$REPO/$BRANCH/$REMOTE_DIR"
9+
10+
AGENTS_DIR="$HOME/.agents/skills/$SKILL_NAME"
11+
CLAUDE_DIR="$HOME/.claude/skills/$SKILL_NAME"
12+
13+
echo "Installing $SKILL_NAME skill..."
14+
15+
# Create target directory
16+
mkdir -p "$AGENTS_DIR/references"
17+
18+
# Download SKILL.md and reference files
19+
curl -fsSL "$BASE_URL/SKILL.md" -o "$AGENTS_DIR/SKILL.md"
20+
for ref in generation.md migration.md patterns.md validation.md yaml-schema.md; do
21+
curl -fsSL "$BASE_URL/references/$ref" -o "$AGENTS_DIR/references/$ref"
22+
done
23+
24+
# Symlink into Claude skills
25+
mkdir -p "$HOME/.claude/skills"
26+
if [ -L "$CLAUDE_DIR" ]; then
27+
rm "$CLAUDE_DIR"
28+
elif [ -d "$CLAUDE_DIR" ]; then
29+
echo "Warning: $CLAUDE_DIR exists and is not a symlink. Skipping symlink creation."
30+
echo "Skill files installed to $AGENTS_DIR"
31+
exit 0
32+
fi
33+
ln -s "$AGENTS_DIR" "$CLAUDE_DIR"
34+
35+
echo "Installed to $AGENTS_DIR"
36+
echo "Symlinked to $CLAUDE_DIR"
37+
echo "Done. The skill is now available in Claude Code and compatible agents."

0 commit comments

Comments
 (0)