Documentation
Technical documentation
Use this page as the map. Start with a project, learn the runtime model, then jump into authoring, automation, and reference material when you need details.
Start
Understand the model, install Linkar, configure packs, and run the first template.
- Why Linkar The problem Linkar solves and the constraints it optimizes for.
- Quickstart Install Linkar, initialize a project, run a template, and inspect outputs.
- Packs and scope Understand global packs, project packs, and explicit pack references.
- Git-backed packs Update remote packs and switch between local and GitHub-backed sources.
Projects
Understand project state, runs, metadata, cleanup, and reproducibility.
- Project lifecycle Render, run, collect, clean, inspect, and prune in context.
- Project runs and metadata What lives in `project.yaml` and under `.linkar/`.
- Pack and project model Why reusable assets and local work live in separate places.
- Reproducibility and versioning Pack revisions, run metadata, and update policy.
Templates
Write template contracts, resolve params, test locally, and wrap external tools.
- Template runtime contract The `linkar_template.yaml` contract and render/run behavior.
- Params, bindings, and resolution How explicit params, defaults, and pack bindings interact.
- Authoring script.sh templates Use shell entrypoints when local orchestration is still simple.
- Python entrypoints Move complex template logic into Python while keeping run scripts small.
- Testing templates Test template behavior and output contracts locally.
- Wrapping external pipelines Turn external CLI workflows into inspectable Linkar templates.
- Build a real pack Create a useful pack with templates and bindings.
Automation
Use Linkar from local services, agents, and site-specific discovery layers.
- CLI, API, and MCP interfaces The shared runtime semantics across human and machine interfaces.
- Local API reference HTTP endpoints and response conventions.
- Using Linkar from agents Use the CLI, API, and MCP server from automation clients.
- Discovery layers and site packs How site-specific lookup logic belongs in packs.
Reference
Lookup material for commands, API surfaces, examples, and advanced details.