Skip to content

CalcMark/agent-skill

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

CalcMark Agent Skill

Teach AI coding agents to use CalcMark — a calculation language that blends CommonMark markdown with inline calculations for budgets, capacity plans, cost models, and project estimates.

Install

One command per platform. Run from your project root for project-level install, or from ~ for global install (all projects).

Scope Where to run Effect
Project Project root Skill available in that project only
Global Home directory (~) Skill available in all projects

Claude Code

curl -sL --create-dirs -o .claude/skills/calcmark/SKILL.md \
  https://raw.githubusercontent.com/CalcMark/agent-skill/main/platforms/claude-code/.claude/skills/calcmark/SKILL.md

Cursor

curl -sL --create-dirs -o .cursor/rules/calcmark.mdc \
  https://raw.githubusercontent.com/CalcMark/agent-skill/main/platforms/cursor/.cursor/rules/calcmark.mdc

GitHub Copilot CLI

curl -sL --create-dirs -o .github/skills/calcmark/SKILL.md \
  https://raw.githubusercontent.com/CalcMark/agent-skill/main/platforms/copilot-cli/.github/skills/calcmark/SKILL.md

Gemini CLI

curl -sL --create-dirs -o .gemini/skills/calcmark/SKILL.md \
  https://raw.githubusercontent.com/CalcMark/agent-skill/main/platforms/gemini-cli/.gemini/skills/calcmark/SKILL.md

What the Agent Gets

Once installed, your agent knows how to:

  • Run calculationsecho "compound $10000 by 7% monthly over 30 years" | cm --format json
  • Write .cm documents as auditable research artifacts with prose and calculations
  • Convert to deliverablescm convert budget.cm --to=html -o budget.html
  • Use domain-specific functions — capacity planning, storage I/O, network latency, compound growth, depreciation
  • Discover features at runtimecm help functions, cm help constants
  • Install CalcMark if cm is not in PATH (with user confirmation)

The skill points agents to the full Agent Integration Guide and carries a compact offline cheat sheet covering syntax, CLI patterns, and JSON output format.

Examples

The examples/ directory shows what agents produce:

File Pattern
quick-calc.cm One-liners — unit conversion, rates, napkin math
research-artifact.cm Multi-step infrastructure capacity analysis
budget-deliverable.cm Full SaaS financial model with frontmatter, exchange rates, and summary table

Run any example: cm eval examples/quick-calc.cm

How It Works

CALCMARK-AGENT.md          ← single source of truth (body content)
    │
    ├─→ Cursor (.mdc)      ┐
    ├─→ Copilot CLI         ├─ generated by scripts/refresh.sh
    └─→ Gemini CLI          ┘

Claude Code                 ← maintained separately (uses WebFetch for full docs)

Edit CALCMARK-AGENT.md, then run ./scripts/refresh.sh to regenerate the platform files. CI runs ./scripts/refresh.sh --check to guard against drift.

Requires CalcMark CLI

The skill instructs agents to install cm automatically, but you can install it yourself:

brew install calcmark/tap/calcmark

Or download from GitHub Releases.

License

MIT

About

Teach AI coding agents to use CalcMark for calculations, capacity planning, and computational documents

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages