Jason Woltje
80c3680ccb
Rename the `rails/` directory to `tools/` for agent discoverability — agents frequently failed to locate helper scripts due to the non-intuitive directory name. Add backward-compat symlink `rails/ → tools/`. New tool suites: - Authentik: auth-token, user-list, user-create, group-list, app-list, flow-list, admin-status (8 scripts) - Coolify: team-list, project-list, service-list, service-status, deploy, env-set (7 scripts) - Woodpecker: pipeline-list, pipeline-status, pipeline-trigger (3 stubs) - GLPI: session-init, computer-list, ticket-list, ticket-create, user-list (6 scripts) - Health: stack-health.sh — stack-wide connectivity check Infrastructure: - Shared credential loader at tools/_lib/credentials.sh - install.sh creates symlink + chmod on tool scripts - All ~253 rails/ path references updated across 68+ files Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
128 lines
3.5 KiB
Markdown
128 lines
3.5 KiB
Markdown
# Machine-Level Tool Reference
|
|
|
|
Centralized reference for tools, credentials, and CLI patterns available across all projects.
|
|
Project-specific tooling belongs in the project's `AGENTS.md`, not here.
|
|
|
|
All tool suites are located at `~/.config/mosaic/tools/`.
|
|
|
|
## Tool Suites
|
|
|
|
### Git Wrappers (Use First)
|
|
|
|
Mosaic wrappers at `~/.config/mosaic/tools/git/*.sh` handle platform detection and edge cases. Always use these before raw CLI commands.
|
|
|
|
```bash
|
|
# Issues
|
|
~/.config/mosaic/tools/git/issue-create.sh
|
|
~/.config/mosaic/tools/git/issue-close.sh
|
|
|
|
# PRs
|
|
~/.config/mosaic/tools/git/pr-create.sh
|
|
~/.config/mosaic/tools/git/pr-merge.sh
|
|
|
|
# Milestones
|
|
~/.config/mosaic/tools/git/milestone-create.sh
|
|
|
|
# CI queue guard (required before push/merge)
|
|
~/.config/mosaic/tools/git/ci-queue-wait.sh --purpose push|merge
|
|
```
|
|
|
|
### Code Review (Codex)
|
|
|
|
```bash
|
|
~/.config/mosaic/tools/codex/codex-code-review.sh --uncommitted
|
|
~/.config/mosaic/tools/codex/codex-security-review.sh --uncommitted
|
|
```
|
|
|
|
### Infrastructure — Portainer
|
|
|
|
```bash
|
|
~/.config/mosaic/tools/portainer/stack-status.sh -n <stack-name>
|
|
~/.config/mosaic/tools/portainer/stack-redeploy.sh -n <stack-name>
|
|
~/.config/mosaic/tools/portainer/stack-list.sh
|
|
~/.config/mosaic/tools/portainer/endpoint-list.sh
|
|
```
|
|
|
|
### Infrastructure — Coolify
|
|
|
|
```bash
|
|
~/.config/mosaic/tools/coolify/project-list.sh
|
|
~/.config/mosaic/tools/coolify/service-list.sh
|
|
~/.config/mosaic/tools/coolify/service-status.sh -u <uuid>
|
|
~/.config/mosaic/tools/coolify/deploy.sh -u <uuid>
|
|
~/.config/mosaic/tools/coolify/env-set.sh -u <uuid> -k KEY -v VALUE
|
|
```
|
|
|
|
### Identity — Authentik
|
|
|
|
```bash
|
|
~/.config/mosaic/tools/authentik/user-list.sh
|
|
~/.config/mosaic/tools/authentik/user-create.sh -u <username> -n <name> -e <email>
|
|
~/.config/mosaic/tools/authentik/group-list.sh
|
|
~/.config/mosaic/tools/authentik/app-list.sh
|
|
~/.config/mosaic/tools/authentik/flow-list.sh
|
|
~/.config/mosaic/tools/authentik/admin-status.sh
|
|
```
|
|
|
|
### CI/CD — Woodpecker
|
|
|
|
```bash
|
|
~/.config/mosaic/tools/woodpecker/pipeline-list.sh
|
|
~/.config/mosaic/tools/woodpecker/pipeline-status.sh
|
|
~/.config/mosaic/tools/woodpecker/pipeline-trigger.sh -b <branch>
|
|
```
|
|
|
|
### IT Service — GLPI
|
|
|
|
```bash
|
|
~/.config/mosaic/tools/glpi/ticket-list.sh
|
|
~/.config/mosaic/tools/glpi/ticket-create.sh -t <title> -c <content>
|
|
~/.config/mosaic/tools/glpi/computer-list.sh
|
|
~/.config/mosaic/tools/glpi/user-list.sh
|
|
```
|
|
|
|
### Health Check
|
|
|
|
```bash
|
|
# Check all configured services
|
|
~/.config/mosaic/tools/health/stack-health.sh
|
|
|
|
# Check a specific service
|
|
~/.config/mosaic/tools/health/stack-health.sh -s portainer
|
|
|
|
# JSON output for automation
|
|
~/.config/mosaic/tools/health/stack-health.sh -f json
|
|
```
|
|
|
|
### Shared Credential Loader
|
|
|
|
```bash
|
|
# Source in any script to load service credentials
|
|
source ~/.config/mosaic/tools/_lib/credentials.sh
|
|
load_credentials <service-name>
|
|
# Supported: portainer, coolify, authentik, glpi, github, gitea-mosaicstack, gitea-usc, woodpecker
|
|
```
|
|
|
|
## Git Providers
|
|
|
|
| Instance | URL | CLI | Purpose |
|
|
|----------|-----|-----|---------|
|
|
| (add your git providers here) | | | |
|
|
|
|
## Credentials
|
|
|
|
**Location:** (configure your credential file path)
|
|
**Loader:** `source ~/.config/mosaic/tools/_lib/credentials.sh && load_credentials <service>`
|
|
|
|
**Never expose actual values. Never commit credential files.**
|
|
|
|
## CLI Gotchas
|
|
|
|
(Add platform-specific CLI gotchas as you discover them.)
|
|
|
|
## Safety Defaults
|
|
|
|
- Prefer `trash` over `rm` when available — recoverable beats gone forever
|
|
- Never run destructive commands without explicit instruction
|
|
- Write it down — "mental notes" don't survive session restarts; files do
|