|
1 | 1 | # Sidemantic |
2 | 2 |
|
3 | | -SQL-first semantic layer for consistent metrics across your data stack. Compatible with many other semantic model formats. |
| 3 | +The universal metrics layer for consistent metrics across your data stack. Compatible with 15+ semantic model formats. |
4 | 4 |
|
5 | | -- **Formats:** Sidemantic, Cube, MetricFlow (dbt), LookML, Hex, Rill, Superset, Omni, BSL, GoodData LDM, Snowflake Cortex, Malloy, OSI, AtScale SML, ThoughtSpot TML |
6 | | -- **Databases:** DuckDB, MotherDuck, PostgreSQL, BigQuery, Snowflake, ClickHouse, Databricks, Spark SQL |
| 5 | +- **Supported Formats:** Sidemantic (YAML, Python or SQL), Cube, dbt MetricFlow, LookML, Hex, Rill, Superset, Omni, BSL, GoodData LDM, Snowflake Cortex, Malloy, OSI, AtScale SML, ThoughtSpot TML |
| 6 | +- **Databases:** DuckDB, MotherDuck, PostgreSQL, BigQuery, Snowflake, ClickHouse, Databricks, Spark SQL (also via ADBC) |
7 | 7 |
|
8 | | -[Documentation](https://sidemantic.com) | [GitHub](https://github.com/sidequery/sidemantic) | [Discord](https://discord.com/invite/7MZ4UgSVvF) | [Demo](https://sidemantic.com/demo) (50+ MB download) |
| 8 | +[Documentation](https://sidemantic.com) | [GitHub](https://github.com/sidequery/sidemantic) | [Docker Hub](https://hub.docker.com/repository/docker/sidequery/sidemantic) | [Discord](https://discord.com/invite/7MZ4UgSVvF) | [Demo](https://sidemantic.com/demo) (50+ MB data download, runs in your browser with Pyodide + DuckDB) |
9 | 9 |
|
10 | 10 |  |
11 | 11 |
|
12 | | -## Should I use Sidemantic |
13 | | - |
14 | | -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. |
15 | | - |
16 | | -Issue reports are much appreciated if you try out Sidemantic and hit a snag 🫡 |
| 12 | +The installer downloads the skill to `~/.agents/skills/sidemantic-modeler` and symlinks it into `~/.claude/skills/`. |
17 | 13 |
|
18 | 14 | ## Quickstart |
19 | 15 |
|
@@ -252,6 +248,44 @@ load_from_directory(layer, "my_models/") # Auto-detects formats |
252 | 248 | | Databricks | ✅ | `uv add sidemantic[databricks]` | |
253 | 249 | | Spark SQL | ✅ | `uv add sidemantic[spark]` | |
254 | 250 |
|
| 251 | +## Docker |
| 252 | + |
| 253 | +The published image is [`sidequery/sidemantic`](https://hub.docker.com/r/sidequery/sidemantic) on Docker Hub. Mount your models directory as a volume at `/app/models`: |
| 254 | + |
| 255 | +```bash |
| 256 | +docker run -p 5433:5433 -v ./models:/app/models sidequery/sidemantic |
| 257 | +``` |
| 258 | + |
| 259 | +Demo mode (built-in sample data, no volume needed): |
| 260 | + |
| 261 | +```bash |
| 262 | +docker run -p 5433:5433 sidequery/sidemantic --demo |
| 263 | +``` |
| 264 | + |
| 265 | +See [`examples/docker/`](examples/docker/) for MCP mode, env vars, building from source, and integration test services. |
| 266 | + |
| 267 | +## Agent Skill |
| 268 | + |
| 269 | +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. |
| 270 | + |
| 271 | +**One-liner install (no clone required):** |
| 272 | + |
| 273 | +```bash |
| 274 | +curl -fsSL https://raw.githubusercontent.com/sidequery/sidemantic/main/skills/install.sh | bash |
| 275 | +``` |
| 276 | + |
| 277 | +**npx / bunx:** |
| 278 | + |
| 279 | +```bash |
| 280 | +npx skills add https://github.com/sidequery/sidemantic --skill sidemantic-modeler |
| 281 | +# or |
| 282 | +bunx skills add https://github.com/sidequery/sidemantic --skill sidemantic-modeler |
| 283 | +``` |
| 284 | + |
| 285 | +## How mature is Sidemantic? |
| 286 | + |
| 287 | +Sidemantic is an ambitious but young semantic layer project. You could 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. |
| 288 | + |
255 | 289 | ## Testing |
256 | 290 |
|
257 | 291 | ```bash |
|
0 commit comments