docs: configuration table with defaults and TOOLS.md example
This commit is contained in:
@@ -21,16 +21,35 @@ Output: convention repos (one per project analyzed).
|
||||
|
||||
## Configuration
|
||||
|
||||
These are provided by the invoker's environment (TOOLS.md, AGENTS.md,
|
||||
or invocation context):
|
||||
Set these in your workspace context (TOOLS.md, AGENTS.md, or pass
|
||||
explicitly when invoking the skill):
|
||||
|
||||
- **CLONE_DIR** — where to clone repos (e.g., `~/src/analysis/`)
|
||||
- **CLONE_HOST** — which machine to clone on (needs disk + git)
|
||||
- **GIT_REMOTE** — where convention repos are pushed (e.g., Gitea, GitHub)
|
||||
- **GIT_ORG** — organization/user for convention repos
|
||||
- **GIT_TOKEN_PATH** — path to auth token for pushing
|
||||
| Parameter | Description | Example |
|
||||
|-----------|-------------|----------|
|
||||
| `CLONE_DIR` | Directory to clone repos into | `~/src/analysis/` |
|
||||
| `CLONE_HOST` | Machine with disk + git for cloning | `forge`, `localhost` |
|
||||
| `GIT_REMOTE` | Where convention repos are pushed | `https://gitea.example.com` |
|
||||
| `GIT_ORG` | Org/user for convention repos | `myorg`, `username` |
|
||||
| `GIT_TOKEN_PATH` | Path to auth token for pushing | `~/.credentials/gitea-token` |
|
||||
|
||||
If not explicitly provided, infer from workspace context.
|
||||
**Minimum required:** `CLONE_DIR` and `GIT_REMOTE`. If others are
|
||||
omitted:
|
||||
- `CLONE_HOST` defaults to localhost (current machine)
|
||||
- `GIT_ORG` defaults to the authenticated user
|
||||
- `GIT_TOKEN_PATH` uses default git credential helper
|
||||
|
||||
**Example in TOOLS.md:**
|
||||
```markdown
|
||||
## Codebase Analysis
|
||||
- CLONE_DIR: ~/src/analysis/
|
||||
- CLONE_HOST: my-dev-server (ssh user@host)
|
||||
- GIT_REMOTE: https://github.com
|
||||
- GIT_ORG: my-patterns
|
||||
- GIT_TOKEN_PATH: ~/.credentials/github-token
|
||||
```
|
||||
|
||||
If not explicitly provided, infer from workspace context (TOOLS.md,
|
||||
shell environment, or git remote configuration).
|
||||
|
||||
## Naming
|
||||
|
||||
|
||||
Reference in New Issue
Block a user