Ark

This site is private. Enter the password to continue.

docs / audit / dimensions

6 dimensions

The audit evaluates your package across six dimensions. Each dimension has a maximum score. D1–D5 are static analysis (free). D6 requires Claude (full audit only).

DimensionPointsMode
D1 Structure20Static
D2 Security20Static
D3 Code Quality20Static
D4 Completeness15Static
D5 Robustness15Static
D6 Value10Full (Claude)

D1 — Structure (20 pts)

Validates the package organization and manifest.

CheckPoints
ark.json exists and is valid JSON4
All required fields present in ark.json4
version follows semver format2
Installer script exists at declared path4
Installer is executable (chmod +x)2
Package name matches directory name2
No unexpected top-level files (clean structure)2

D2 — Security (20 pts)

Checks for common security issues. A perfect D2 score is achievable by all packages that follow basic hygiene.

CheckPoints
No API keys, tokens, or passwords in any file6
.gitignore present (excludes sensitive files)3
No sudo in installer scripts4
No command injection patterns (eval, $(), unsafe quoting)4
No writes outside ~/.ark/ or ~/.claude/3
D2 Security is a hard blocker. A package with detected secrets scores 0 in D2, making certification impossible regardless of other dimensions.

D3 — Code Quality (20 pts)

Evaluates the quality of bash scripts and documentation.

CheckPoints
bash -n passes (no syntax errors)5
CLAUDE.md exists and has content4
set -euo pipefail in bash scripts3
Error handling (if/fi blocks, exit codes)4
Meaningful comments in scripts2
Consistent indentation and formatting2

D4 — Completeness (15 pts)

Checks that all declared components are present and documented.

CheckPoints
README.md exists3
README covers installation and usage3
structure fields in ark.json match actual files4
All slash commands documented in CLAUDE.md3
Changelog or version notes present2

D5 — Robustness (15 pts)

Tests whether the installer handles edge cases gracefully.

CheckPoints
Verify script (bin/verify.sh) exists4
Installer is idempotent (safe to run twice)4
Handles missing directories (mkdir -p pattern)3
Requirements validation before install2
Graceful failure messages (not just exit 1)2

D6 — Value (10 pts, full mode only)

A Claude evaluation of the package's actual usefulness. This is subjective and qualitative — designed to reward genuine expertise and originality.

CheckPoints
Solves a real, specific problem (not generic)4
Domain expertise evident in prompts/CLAUDE.md3
Documentation quality and clarity2
Originality (not a trivial wrapper)1