{
  "markdown": "# spec-objects-operational\n\n> Filament Module: tier-2 operational ObjectTypes (configuration, migration, hook, job, sli, slo)\n\nAgent-IX Filament module loaded by [`quire-cli`](https://github.com/agent-ix/quire-cli) and [`quoin`](https://github.com/agent-ix/quoin).\n\n## Installing quire-cli\n\n`@agent-ix` packages are published to public npm. Install the CLI globally:\n\n```bash\nnpm install -g @agent-ix/quire-cli\n```\n\nSee https://github.com/agent-ix/quire-cli#install for details.\n\n## Install this module via npm\n\nThis module is also published as a config-only npm package: `@agent-ix/spec-objects-operational`.\nThe package root **is** the Filament module (`manifest.yaml` + schemas/skeletons),\nso it works directly as a `--module` target or via quoin's `package:` source.\n\n```bash\nnpm install @agent-ix/spec-objects-operational\n```\n\n```bash\n# quoin — resolve the module from npm by name\nquoin plugin install package:@agent-ix/spec-objects-operational\n\n# or point any tool at the installed package root\nquire validate spec/**/*.md --module node_modules/@agent-ix/spec-objects-operational\n```\n\n## Object types provided\n\n| Object | `type:` | Description |\n|--------|---------|-------------|\n| Configuration | `configuration` | A service's tunable settings as a required `## Configuration` table (Name, Scope, Type, Default, Description), where Scope ∈ creation \\| runtime \\| session, plus optional load/reload Behavior. |\n| Migration | `migration` | A database migration carrying its runnable, idempotent/guarded change in a required `## Migration` SQL code block. |\n| SLI | `sli` | A service-level indicator defining what is measured (e.g. the success ratio) via a required `## Query` code block. |\n| SLO | `slo` | A service-level objective with frontmatter `target` and `window` fields, describing the reliability goal and its error budget. |\n| Alert | `alert` | A burn-rate/monitoring alert whose escalation logic is a required `## Flow` mermaid diagram. |\n| Runbook | `runbook` | An ordered, executable response procedure captured as a required `## Steps` list with the exact operator commands. |\n| Incident | `incident` | A post-incident record with a required `## Timeline` of timestamped (UTC), ordered, factual events. |\n| Deployment | `deployment` | A deployment topology rendered as a required `## Topology` mermaid diagram of replicas, services, and dependencies. |\n\n## How this module is used\n\n### With quoin (recommended)\n\n```bash\nquoin plugin install path:../spec-objects-operational\nquoin catalog list\nquoin write . --types configuration,slo\nquoin review\n```\n\nSee https://github.com/agent-ix/quoin.\n\n### With quire-cli directly\n\n```bash\nquire schema configuration --module ./spec_objects_operational\nquire validate spec/**/*.md --module ./spec_objects_operational\nquire extract SLO-001.md --module ./spec_objects_operational\n```\n\nSee https://github.com/agent-ix/quire-cli#usage-instructions.\n\n## Development\n\nPython 3.13+ package (`spec_objects_operational`, flat layout) managed with Poetry. CI runs on GitHub Actions and publishes to Google Artifact Registry (PyPI-compatible) on `tag v*.*.*`.\n\n```bash\nmake install          # install dependencies in Poetry venv\nmake test             # run pytest\nmake lint             # ruff + black check\nmake format           # ruff + black format\nmake build            # build wheel and sdist under dist/\nmake update-lock      # update poetry.lock\nmake use-local p=<name>     # switch dep to local pypi.ix\nmake use-upstream p=<name>  # switch dep back to upstream\nmake local-publish    # build and publish to local pypi.ix\n```\n\nInstall from local PyPI:\n\n```bash\npip install --index-url http://pypi.ix/root/dev/+simple/ spec_objects_operational\n```\n\nCI requires the `GCP_SERVICE_ACCOUNT_KEY` secret and the `GCP_REGION`, `GCP_PROJECT_NAME`, and `GCP_PYPI` variables for Artifact Registry publishing. Versioning is dynamic from the Git tag.\n",
  "bytes": 3890,
  "sha": "f27bfcf23afb5eb40e0ad3fbf92e1dc095454b0b74a60cd23f020dcc5c808f60",
  "repo_slug": "agent-ix/spec-objects-operational",
  "fonte": "repo",
  "truncated": false,
  "api": "https://agentalog.com/api/listings/okf_agent_ix_spec_objects_operational_spec_i_f4f3f5e9/readme"
}