Skip to content

Commit eeef415

Browse files
hyperpolymathclaude
hyperpolymath
and
claude
committed
chore: add UX infrastructure (quickstart, doctor, setup)
Added by ux-rollout.jl batch script. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 28fc7c0 commit eeef415

7 files changed

Lines changed: 325 additions & 0 deletions

File tree

‎Justfile‎

Lines changed: 102 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,3 +28,105 @@ fmt:
2828
# Run panic-attacker pre-commit scan
2929
assail:
3030
@command -v panic-attack >/dev/null 2>&1 && panic-attack assail . || echo "panic-attack not found — install from https://github.com/hyperpolymath/panic-attacker"
31+
32+
# ═══════════════════════════════════════════════════════════════════════════════
33+
# ONBOARDING & DIAGNOSTICS
34+
# ═══════════════════════════════════════════════════════════════════════════════
35+
36+
# Check all required toolchain dependencies and report health
37+
doctor:
38+
#!/usr/bin/env bash
39+
echo "═══════════════════════════════════════════════════"
40+
echo " Checky Monkey Doctor — Toolchain Health Check"
41+
echo "═══════════════════════════════════════════════════"
42+
echo ""
43+
PASS=0; FAIL=0; WARN=0
44+
check() {
45+
local name="$1" cmd="$2" min="$3"
46+
if command -v "$cmd" >/dev/null 2>&1; then
47+
VER=$("$cmd" --version 2>&1 | head -1)
48+
echo " [OK] $name — $VER"
49+
PASS=$((PASS + 1))
50+
else
51+
echo " [FAIL] $name — not found (need $min+)"
52+
FAIL=$((FAIL + 1))
53+
fi
54+
}
55+
check "just" just "1.25"
56+
check "git" git "2.40"
57+
check "Zig" zig "0.13"
58+
# Optional tools
59+
if command -v panic-attack >/dev/null 2>&1; then
60+
echo " [OK] panic-attack — available"
61+
PASS=$((PASS + 1))
62+
else
63+
echo " [WARN] panic-attack — not found (pre-commit scanner)"
64+
WARN=$((WARN + 1))
65+
fi
66+
echo ""
67+
echo " Result: $PASS passed, $FAIL failed, $WARN warnings"
68+
if [ "$FAIL" -gt 0 ]; then
69+
echo " Run 'just heal' to attempt automatic repair."
70+
exit 1
71+
fi
72+
echo " All required tools present."
73+
74+
# Attempt to automatically install missing tools
75+
heal:
76+
#!/usr/bin/env bash
77+
echo "═══════════════════════════════════════════════════"
78+
echo " Checky Monkey Heal — Automatic Tool Installation"
79+
echo "═══════════════════════════════════════════════════"
80+
echo ""
81+
if ! command -v just >/dev/null 2>&1; then
82+
echo "Installing just..."
83+
cargo install just 2>/dev/null || echo "Install just from https://just.systems"
84+
fi
85+
echo ""
86+
echo "Heal complete. Run 'just doctor' to verify."
87+
88+
# Guided tour of the project structure and key concepts
89+
tour:
90+
#!/usr/bin/env bash
91+
echo "═══════════════════════════════════════════════════"
92+
echo " Checky Monkey — Guided Tour"
93+
echo "═══════════════════════════════════════════════════"
94+
echo ""
95+
echo '<img src="docs/images/checky-monkey-logo.svg" alt="Checky Monkey Logo" width="200"/>'
96+
echo ""
97+
echo "Key directories:"
98+
echo " src/ Source code"
99+
echo " ffi/ Foreign function interface (Zig)"
100+
echo " src/abi/ Idris2 ABI definitions"
101+
echo " docs/ Documentation"
102+
echo " tests/ Test suite"
103+
echo " .github/workflows/ CI/CD workflows"
104+
echo " contractiles/ Must/Trust/Dust contracts"
105+
echo " .machine_readable/ Machine-readable metadata"
106+
echo " examples/ Usage examples"
107+
echo ""
108+
echo "Quick commands:"
109+
echo " just doctor Check toolchain health"
110+
echo " just heal Fix missing tools"
111+
echo " just help-me Common workflows"
112+
echo " just default List all recipes"
113+
echo ""
114+
echo "Read more: README.adoc, EXPLAINME.adoc"
115+
116+
# Show help for common workflows
117+
help-me:
118+
#!/usr/bin/env bash
119+
echo "═══════════════════════════════════════════════════"
120+
echo " Checky Monkey — Common Workflows"
121+
echo "═══════════════════════════════════════════════════"
122+
echo ""
123+
echo "FIRST TIME SETUP:"
124+
echo " just doctor Check toolchain"
125+
echo " just heal Fix missing tools"
126+
echo ""
127+
echo "PRE-COMMIT:"
128+
echo " just assail Run panic-attacker scan"
129+
echo ""
130+
echo "LEARN:"
131+
echo " just tour Guided project tour"
132+
echo " just default List all recipes"

‎QUICKSTART-DEV.adoc‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
= Checky Monkey — Developer Quickstart
2+
:toc: preamble
3+
4+
Clone, build, test, contribute.
5+
6+
== Prerequisites
7+
8+
* Git 2.40+
9+
* just (command runner)
10+
* See `just doctor` output for language-specific requirements
11+
12+
== Setup
13+
14+
[source,bash]
15+
----
16+
git clone https://github.com/hyperpolymath/checky-monkey
17+
cd checky-monkey
18+
just doctor # verify toolchain
19+
just heal # auto-install missing tools
20+
----
21+
22+
== Development Workflow
23+
24+
[source,bash]
25+
----
26+
just tour # understand the codebase
27+
just help-me # see available commands
28+
----
29+
30+
== Before Committing
31+
32+
[source,bash]
33+
----
34+
just assail # run panic-attacker security scan
35+
----
36+
37+
== Contributing
38+
39+
See link:CONTRIBUTING.md[CONTRIBUTING.md] for guidelines.

‎QUICKSTART-MAINTAINER.adoc‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
= Checky Monkey — Maintainer Quickstart
2+
:toc: preamble
3+
4+
Packaging, deployment, and release management.
5+
6+
== Prerequisites
7+
8+
* Git 2.40+
9+
* just (command runner)
10+
* Familiarity with the project (run `just tour` first)
11+
12+
== CI/CD
13+
14+
This project uses GitHub Actions. Workflows are in `.github/workflows/`.
15+
16+
Key workflows:
17+
18+
* `hypatia-scan.yml` — Neurosymbolic security scanning
19+
* `codeql.yml` — Code analysis
20+
* `scorecard.yml` — OpenSSF Scorecard
21+
* `mirror.yml` — GitLab/Bitbucket mirroring
22+
23+
== Releasing
24+
25+
1. Update version in project config
26+
2. Update CHANGELOG.md
27+
3. Tag: `git tag -s v<VERSION>`
28+
4. Push: `git push origin main --tags`
29+
30+
== Container Build (if applicable)
31+
32+
[source,bash]
33+
----
34+
podman build -f Containerfile -t checky-monkey:latest .
35+
----
36+
37+
== Mirrors
38+
39+
This repo is mirrored to GitLab and Bitbucket (hyperpolymath accounts)
40+
via the `mirror.yml` workflow.

‎QUICKSTART-USER.adoc‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
= Checky Monkey — User Quickstart
2+
:toc: preamble
3+
4+
Get up and running in 60 seconds.
5+
6+
== Prerequisites
7+
8+
* Git 2.40+
9+
* just (command runner) — https://just.systems
10+
11+
== Install
12+
13+
[source,bash]
14+
----
15+
git clone https://github.com/hyperpolymath/checky-monkey
16+
cd checky-monkey
17+
just doctor # check toolchain
18+
just heal # auto-install missing tools
19+
----
20+
21+
== First Run
22+
23+
[source,bash]
24+
----
25+
just tour # guided project tour
26+
just help-me # see common workflows
27+
----
28+
29+
== Get Help
30+
31+
* `just help-me` — common workflows
32+
* `just doctor` — diagnose toolchain issues
33+
* https://github.com/hyperpolymath/checky-monkey/issues — report bugs

‎contractiles/intend/Intentfile.a2ml‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# SPDX-License-Identifier: PMPL-1.0-or-later
2+
# Intentfile (A2ML Canonical)
3+
# Copyright (c) 2026 Jonathan D.A. Jewell (hyperpolymath)
4+
5+
@abstract:
6+
Declared intent and purpose for Checky Monkey.
7+
@end
8+
9+
## Purpose
10+
11+
Checky Monkey — <p align="center">
12+
13+
## Anti-Purpose
14+
15+
This project is NOT:
16+
- A fork or wrapper around another tool
17+
- A monorepo (unless explicitly structured as one)
18+
19+
## If In Doubt
20+
21+
If you are unsure whether a change is in scope, ask.
22+
Sensitive areas: ABI definitions, license headers, CI workflows.

‎contractiles/trust/Trustfile.a2ml‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# SPDX-License-Identifier: PMPL-1.0-or-later
2+
# Trustfile (A2ML Canonical)
3+
# Copyright (c) 2026 Jonathan D.A. Jewell (hyperpolymath)
4+
5+
@abstract:
6+
Trust and provenance verification for Checky Monkey.
7+
Maximal trust by default — LLM may read, build, test, lint, format.
8+
@end
9+
10+
@trust-level: maximal
11+
@trust-boundary: repo
12+
@trust-actions: [read, build, test, lint, format]
13+
@trust-deny: [delete-branch, force-push, modify-ci-secrets, publish]
14+
15+
## Integrity
16+
17+
### license-content
18+
- description: LICENSE contains expected SPDX identifier
19+
- run: grep -q 'SPDX\|License\|MIT\|Apache\|PMPL\|MPL' LICENSE
20+
- severity: critical
21+
22+
### no-secrets-committed
23+
- description: No .env or credential files in repo
24+
- run: test ! -f .env && test ! -f credentials.json && test ! -f .env.local
25+
- severity: critical

‎setup.sh‎

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
#!/usr/bin/env bash
2+
# SPDX-License-Identifier: PMPL-1.0-or-later
3+
# Copyright (c) 2026 Jonathan D.A. Jewell (hyperpolymath)
4+
#
5+
# Checky Monkey — Universal Setup Script
6+
# Detects platform and shell, installs just, then hands off to Justfile.
7+
8+
set -euo pipefail
9+
10+
echo "═══════════════════════════════════════════════════"
11+
echo " Checky Monkey — Setup"
12+
echo "═══════════════════════════════════════════════════"
13+
echo ""
14+
15+
# Platform detection
16+
OS="$(uname -s)"
17+
ARCH="$(uname -m)"
18+
echo "Platform: $OS $ARCH"
19+
20+
# Shell detection
21+
CURRENT_SHELL="$(basename "$SHELL" 2>/dev/null || echo "unknown")"
22+
echo "Shell: $CURRENT_SHELL"
23+
echo ""
24+
25+
# Check for just
26+
if ! command -v just >/dev/null 2>&1; then
27+
echo "just (command runner) is required but not installed."
28+
echo ""
29+
case "$OS" in
30+
Linux)
31+
if command -v cargo >/dev/null 2>&1; then
32+
echo "Installing just via cargo..."
33+
cargo install just
34+
elif command -v brew >/dev/null 2>&1; then
35+
echo "Installing just via Homebrew..."
36+
brew install just
37+
else
38+
echo "Install just from: https://just.systems/man/en/installation.html"
39+
exit 1
40+
fi
41+
;;
42+
Darwin)
43+
if command -v brew >/dev/null 2>&1; then
44+
echo "Installing just via Homebrew..."
45+
brew install just
46+
else
47+
echo "Install Homebrew first: https://brew.sh"
48+
echo "Then: brew install just"
49+
exit 1
50+
fi
51+
;;
52+
*)
53+
echo "Install just from: https://just.systems/man/en/installation.html"
54+
exit 1
55+
;;
56+
esac
57+
echo ""
58+
fi
59+
60+
echo "Running diagnostics..."
61+
just doctor
62+
63+
echo ""
64+
echo "Setup complete. Run 'just help-me' for common workflows."

0 commit comments

Comments
 (0)