{"id":46391615,"url":"https://github.com/juxt/allium-tools","last_synced_at":"2026-03-05T09:01:40.387Z","repository":{"id":340172441,"uuid":"1160986938","full_name":"juxt/allium-tools","owner":"juxt","description":null,"archived":false,"fork":false,"pushed_at":"2026-03-04T23:56:01.000Z","size":1109,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-03-05T04:59:45.422Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/juxt.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":"AGENTS.md","dco":null,"cla":null}},"created_at":"2026-02-18T15:52:42.000Z","updated_at":"2026-03-01T15:55:00.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/juxt/allium-tools","commit_stats":null,"previous_names":["juxt/allium-tools"],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/juxt/allium-tools","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/juxt%2Fallium-tools","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/juxt%2Fallium-tools/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/juxt%2Fallium-tools/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/juxt%2Fallium-tools/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/juxt","download_url":"https://codeload.github.com/juxt/allium-tools/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/juxt%2Fallium-tools/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30117478,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-05T08:19:04.902Z","status":"ssl_error","status_checked_at":"2026-03-05T08:17:37.148Z","response_time":93,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2026-03-05T09:01:39.806Z","updated_at":"2026-03-05T09:01:40.376Z","avatar_url":"https://github.com/juxt.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Allium Tools\n\n\u003e **Pre-release notice:** This software is currently in a pre-release state. Treat it as unstable, expect breaking changes, and validate it carefully before production use.\n\nAllium Tools is the multi-editor platform for the Allium specification language. It provides rich editor integration, a standalone Language Server (LSP), and a suite of CLI tools for validation, formatting, and analysis.\n\n## What is Allium?\n\nAllium is a domain-specific language for specifying system behavior, rules, and data models. It focuses on clarity, traceability, and automated validation.\n\n### Key Concepts\n\n- **Blocks**: Top-level declarations like `rule`, `entity`, `enum`, `config`, `given`, `surface`, and `actor`.\n- **Clauses**: Express requirements and effects using `when:`, `requires:`, and `ensures:`.\n- **Traceability**: Built-in support for linking specifications to implementation and tests.\n\n### Brief Syntax Example\n\n```allium\nmodule ordering\n\nenum OrderStatus {\n    pending | confirmed | dispatched\n}\n\nentity Order {\n    status: OrderStatus\n    total: Decimal\n}\n\nrule PlaceOrder {\n    when: OrderSubmitted(basket)\n    requires: basket.items.count \u003e 0\n    ensures: Order.created(status: pending, total: basket.total)\n}\n\nrule DispatchOrder {\n    when: order: Order.status becomes confirmed\n    requires: order.total \u003e 0\n    ensures: order.status = dispatched\n}\n```\n\n## Editor Support Matrix\n\n| Feature | VS Code | Neovim | Emacs | CLI |\n| :--- | :---: | :---: | :---: | :---: |\n| Diagnostics (Linting) | ✅ | ✅ | ✅ | ✅ |\n| Hover Documentation | ✅ | ✅ | ✅ | - |\n| Go to Definition | ✅ | ✅ | ✅ | - |\n| Find References | ✅ | ✅ | ✅ | ✅ |\n| Rename Refactoring | ✅ | ✅ | ✅ | - |\n| Safe Fixes (Autofix) | ✅ | ✅ | ✅ | ✅ |\n| Formatting | ✅ | ✅ | ✅ | ✅ |\n| Code Lens | ✅ | - | - | - |\n| Document Links | ✅ | ✅ | ✅ | - |\n| Semantic Highlighting | ✅ | ✅ | ✅ | - |\n| Folding | ✅ | ✅ | ✅ | - |\n| Completions | ✅ | ✅ | ✅ | - |\n| Diagram Preview | ✅ | - | - | ✅ |\n| Rule Simulation | ✅ | - | - | - |\n| Test Scaffold | ✅ | - | - | - |\n\n## Quick Install\n\n### VS Code\n\n1. Download the latest `allium-vscode-\u003cversion\u003e.vsix` from [GitHub Releases](https://github.com/juxt/allium-tools/releases).\n2. Install via Command Palette: `Extensions: Install from VSIX...`.\n3. See the [VS Code Setup Guide](docs/editors/vscode.md) for details.\n\n### Neovim\n\n1. Install `allium-lsp` via your favorite plugin manager or from release artifacts.\n2. Configure `nvim-lspconfig` to point to the `allium-lsp` binary.\n3. See the [Neovim Setup Guide](docs/editors/neovim.md) for details.\n\n### Emacs\n\n1. Install `allium-mode` and configure it to use `allium-lsp` with `eglot` or `lsp-mode`.\n2. See the [Emacs Setup Guide](docs/editors/emacs.md) for details.\n\n## CLI\n\nThe `allium` CLI validates and parses Allium specification files.\n\n- `allium check` — validate specifications and report diagnostics.\n- `allium parse` — parse a file and output the syntax tree.\n\n### Install\n\n**Homebrew**\n\n```bash\nbrew tap juxt/allium \u0026\u0026 brew install allium\n```\n\n**Cargo**\n\n```bash\ncargo install allium-cli\n```\n\n**From source**\n\n```bash\ncargo build --release -p allium-cli\n```\n\nPre-built binaries for Linux and macOS are available on the [GitHub Releases](https://github.com/juxt/allium-tools/releases) page.\n\n## Documentation\n\n- [Architecture Overview](docs/project/architecture.md)\n- [Editor Setup Guides](docs/editors/)\n- [Contributing Guide](CONTRIBUTING.md)\n- [Project Plan \u0026 Roadmap](docs/project/plan.md)\n\n## Development\n\nSee [AGENTS.md](AGENTS.md) for development rules and the [Project Roadmap](docs/project/plan.md) for build instructions and priorities.\n\n### Git Hooks\n\nThis repository uses `pre-commit` hooks for local quality gates.\n\nInstall hooks:\n\n```bash\nnpm install\n```\n\nRun the full test matrix locally:\n\n```bash\nnpm run test:all\n```\n\n`test:all` runs fastest-to-slowest: `test`, `test:nvim`, `test:emacs`, `test:nvim:integration`, `test:emacs:integration`.\n\nThe `pre-push` hook runs `npm run test:all` before allowing a push.\n\n## Licence\n\n[MIT](LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjuxt%2Fallium-tools","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjuxt%2Fallium-tools","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjuxt%2Fallium-tools/lists"}