generated from coulomb/repo-seed
77 lines
2.3 KiB
Markdown
77 lines
2.3 KiB
Markdown
Building interoperable, adaptable, and extensible information-processing systems.
|
|
|
|
## Current Service
|
|
|
|
This repository now implements one concrete infospace under `infospace/`.
|
|
The repository root remains the service, governance, and workplan shell.
|
|
|
|
The first service surface is intentionally small:
|
|
|
|
- JSON-first CLI commands
|
|
- importable Python service functions
|
|
- read-only local HTTP API
|
|
- artifact loading, checks, and graph summaries backed by `infospace-bench`
|
|
|
|
## Source-Tree Usage
|
|
|
|
```bash
|
|
PYTHONPATH=src python3 -m info_tech_canon inspect
|
|
PYTHONPATH=src python3 -m info_tech_canon artifacts
|
|
PYTHONPATH=src python3 -m info_tech_canon models
|
|
PYTHONPATH=src python3 -m info_tech_canon standards
|
|
PYTHONPATH=src python3 -m info_tech_canon validate
|
|
PYTHONPATH=src python3 -m info_tech_canon graph
|
|
PYTHONPATH=src python3 -m info_tech_canon index
|
|
PYTHONPATH=src python3 -m info_tech_canon views
|
|
PYTHONPATH=src python3 -m info_tech_canon profile inspect small-saas
|
|
PYTHONPATH=src python3 -m info_tech_canon profile validate small-saas
|
|
PYTHONPATH=src python3 -m info_tech_canon profile graph small-saas
|
|
PYTHONPATH=src python3 -m info_tech_canon api --host 127.0.0.1 --port 8765
|
|
```
|
|
|
|
After package installation, the same commands are available through the
|
|
`info-tech-canon` console script.
|
|
|
|
## API Endpoints
|
|
|
|
- `GET /health`
|
|
- `GET /inspect`
|
|
- `GET /artifacts`
|
|
- `GET /artifacts?kind=model`
|
|
- `GET /models`
|
|
- `GET /standards`
|
|
- `GET /validate`
|
|
- `GET /graph`
|
|
- `GET /graph?format=mermaid`
|
|
- `GET /views`
|
|
- `GET /views/{name}`
|
|
- `GET /profiles/{profile}/inspect`
|
|
- `GET /profiles/{profile}/validate`
|
|
- `GET /profiles/{profile}/graph`
|
|
|
|
## Maintenance
|
|
|
|
```bash
|
|
make validate
|
|
make index
|
|
make tree
|
|
make agent-briefs
|
|
```
|
|
|
|
## First Profile Proof
|
|
|
|
The first executable profile proof is `small-saas`. It lives under
|
|
`infospace/profiles/small-saas/` and includes connected example artifacts for a
|
|
tenant-aware SaaS service: service, system, tenants, user, team, dataset,
|
|
deployment, task, policy, control, evidence, and incident.
|
|
|
|
## Agent Retrieval
|
|
|
|
Agent-facing retrieval assets live under `infospace/agent/`:
|
|
|
|
- `global-agent-brief.md`
|
|
- `retrieval-index.md`, `retrieval-index.yaml`, and `retrieval-index.json`
|
|
- per-artifact briefs in `agent/briefs/`
|
|
- consumer brief templates in `agent/consumer-briefs/`
|
|
- Canon Interface Card template in `agent/templates/`
|