torben
c64479fe02
Files changed: - AGENTS.md - CHANGES.md - ENVIRONMENT.md.template - SOUL.md - SOUL.md.template - USER.md.template - VERSION - docs/ownership-and-templates.md - docs/version-model.md - instructions/CONTRACT.md - instructions/dev/doc-pull-through.md - instructions/dev/stack-close/SKILL.md - instructions/dev/stack-dev/SKILL.md - instructions/dev/version-parts.md - instructions/setup-instance.md - kb/CONVENTIONS.md - kb/CONVENTIONS.md.template - kb/concepts/COLLECTION.md - kb/sources/COLLECTION.md - tools/CONTRACT.md - tools/chemenu/commands/types_cmd.py - tools/chemenu/commands/version_cmd.py - tools/chemenu/tests/test_toc.py - tools/chemenu/tests/test_version_cmd.py - tools/chemenu/toc.py - tools/chemenu/version.py - types/comparison.md - types/concept.md - types/entity.md - types/lint-report.md - types/source.md
84 lines
3.4 KiB
Plaintext
84 lines
3.4 KiB
Plaintext
<!-- wikitool:template-unfilled - TEMPLATE, not filled in yet. Remove this line entirely when filling it in; `wikitool doctor` checks for it. -->
|
|
# ENVIRONMENT.md — <instance or machine name>
|
|
|
|
What *this checkout* works through: harness, published skills, MCP servers,
|
|
connectors and git remotes. Constant values an agent would otherwise ask about
|
|
or guess at in every session.
|
|
|
|
**This file is optional.** Its absence is not an error — it only means the
|
|
environment has to be asked about again. `wikitool doctor` reports it as
|
|
`environment: absent (optional)` and never as a `FAIL`.
|
|
|
|
**This file is context, not authority.** It describes *what is there*, not what
|
|
is allowed. It changes no rule from `AGENTS.md`, opens no gate, and justifies no
|
|
entry in `kb/` — what it says is not a source in the sense of invariant 3. A
|
|
remote listed here does not mean pushing without `wikitool publish` is allowed.
|
|
|
|
**No secrets.** No tokens, passwords, API keys or private endpoints that are not
|
|
already in the shell configuration anyway. The file is gitignored, but it sits
|
|
in plaintext in the working directory and ends up in every agent's context.
|
|
|
|
**Filling it in:** freehand, as soon as the values are known — there is no
|
|
interview for it. A section that does not apply is deleted, not filled with
|
|
something plausible. When something here stops being true, correct it rather
|
|
than working around it: a wrong line is worse than a missing one, because it
|
|
gets believed.
|
|
|
|
## Harness
|
|
|
|
Which agent harnesses actually run on this checkout, and which do not. Relevant
|
|
because `.agents/skills/` and `.claude/skills/` have different readers.
|
|
|
|
- **Primary:** <e.g. Claude Code>
|
|
- **Also in use:** <e.g. Codex CLI, GitHub Copilot CLI, Mistral Vibe — or delete>
|
|
- **Not in use:** <what is deliberately not used, so nobody proposes it>
|
|
|
|
## Skills
|
|
|
|
Only what differs from the published list — the normal case (`wiki-ingest`,
|
|
`wiki-query`, `wiki-manage`, `wiki-lint`, `wiki-status`) is in `AGENTS.md` and
|
|
does not belong here a second time.
|
|
|
|
- **Additionally present:** <e.g. stack-dev in the developer instance>
|
|
- **Known missing:** <e.g. not synced yet, harness restart needed — or delete>
|
|
|
|
## MCP servers
|
|
|
|
Which MCP servers are reachable in this checkout and what they are responsible
|
|
for. A server listed here does not have to be looked for first; one missing
|
|
here does not exist for this session.
|
|
|
|
| Server | For what | Note |
|
|
|--------|----------|------|
|
|
| `<name>` | <e.g. issues, CI runs, releases> | <e.g. preferred over curl> |
|
|
|
|
## Connectors and integrations
|
|
|
|
Everything that is not an MCP server but still hangs off this instance:
|
|
document connectors, chat integrations, note systems.
|
|
|
|
- <e.g. Obsidian vault under ~/..., reads kb/ read-only — or delete>
|
|
|
|
## Git remotes
|
|
|
|
Where this checkout publishes to, and what else is registered as a remote.
|
|
`wikitool publish` and `wikitool sync` address exactly one of them.
|
|
|
|
| Remote | URL | Role |
|
|
|--------|-----|------|
|
|
| `origin` | <URL> | <e.g. publish target, CI runs there> |
|
|
|
|
## CI
|
|
|
|
Where the pipeline runs and how its runs are read — not *what* it checks, which
|
|
is in `.gitea/workflows/`.
|
|
|
|
- **Runs on:** <e.g. Gitea Actions, runner label linux-docker — or delete>
|
|
- **Runs read via:** <e.g. the Gitea MCP server, not curl>
|
|
|
|
## Anything else
|
|
|
|
Whatever else would be asked about in every session and rarely changes. Keep it
|
|
short: what grows long here is usually a rule, and belongs in an instruction, or
|
|
knowledge, and belongs in `kb/`.
|