Skip to content

Add agent skill with install script and documentation #102

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

Merged
nicosuave merged 1 commit into from
Feb 21, 2026
Merged

Add agent skill with install script and documentation #102

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
20 changes: 20 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,26 @@ A universal metrics layer for consistent metrics across your data stack. Compati

![Jupyter Widget Preview](preview.png)

## Agent Skill

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.

**One-liner install (no clone required):**

```bash
curl -fsSL https://raw.githubusercontent.com/sidequery/sidemantic/main/skills/install.sh | bash
```

**npx / bunx:**

```bash
npx skills add https://github.com/sidequery/sidemantic --skill sidemantic-modeler
# or
bunx skills add https://github.com/sidequery/sidemantic --skill sidemantic-modeler
```

The installer downloads the skill to `~/.agents/skills/sidemantic-modeler` and symlinks it into `~/.claude/skills/`.

## How mature is Sidemantic?

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.
Expand Down
37 changes: 37 additions & 0 deletions skills/install.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
#!/usr/bin/env bash
set -euo pipefail

SKILL_NAME="sidemantic-modeler"
REPO="sidequery/sidemantic"
BRANCH="main"
REMOTE_DIR="skills/$SKILL_NAME"
BASE_URL="https://raw.githubusercontent.com/$REPO/$BRANCH/$REMOTE_DIR"

AGENTS_DIR="$HOME/.agents/skills/$SKILL_NAME"
CLAUDE_DIR="$HOME/.claude/skills/$SKILL_NAME"

echo "Installing $SKILL_NAME skill..."

# Create target directory
mkdir -p "$AGENTS_DIR/references"

# Download SKILL.md and reference files
curl -fsSL "$BASE_URL/SKILL.md" -o "$AGENTS_DIR/SKILL.md"
for ref in generation.md migration.md patterns.md validation.md yaml-schema.md; do
curl -fsSL "$BASE_URL/references/$ref" -o "$AGENTS_DIR/references/$ref"
done

# Symlink into Claude skills
mkdir -p "$HOME/.claude/skills"
if [ -L "$CLAUDE_DIR" ]; then
rm "$CLAUDE_DIR"
elif [ -d "$CLAUDE_DIR" ]; then
echo "Warning: $CLAUDE_DIR exists and is not a symlink. Skipping symlink creation."
echo "Skill files installed to $AGENTS_DIR"
exit 0
fi
ln -s "$AGENTS_DIR" "$CLAUDE_DIR"

echo "Installed to $AGENTS_DIR"
echo "Symlinked to $CLAUDE_DIR"
echo "Done. The skill is now available in Claude Code and compatible agents."
Loading