rubiks-cube-solver cube-engine.instructions.md

Project instructions for a Rust engine that represents and validates Rubik's Cubes and their moves. They define the files to read first and the rules for changing the cube representation, notation, scrambles, and validation.

In plain words
What is it for?
Use them when changing cube data structures, move handling, notation parsing, scramble support, or validation in the Rust cube-engine crate.
Why use it?
They give the coding agent the project's terminology, boundaries, and correctness rules before it edits the engine. This helps preserve valid cube states and predictable behavior.

Instructions file for GitHub Copilot

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add instructions/williamisnotdefined/rubiks-cube-solver/cube-engine
Clone the repo
git clone --depth 1 https://github.com/williamisnotdefined/rubiks-cube-solver

Made for: GitHub Copilot.

Per session 2,911 This file is loaded in full into every session.
When invoked 2,911 The same file — it is already loaded in full.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.02911 $0.02911
Opus 5 $0.01456 $0.01456
Sonnet 5 $0.00582 $0.00582
Haiku 4.5 $0.00291 $0.00291

Measured 2d ago against content hash aa179780260d, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

rubiks-cube-solver cube-engine.instructions.md scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

.github/instructions/cube-engine.instructions.md · 273 lines

How it starts

The opening of the file, as written. The whole thing — 273 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Generated from ai/registry.json. Do not edit manually.

Canonical skill: ../../ai/skills/cube-engine.md.

Referenced context:

  • ../../ai/rules/cube-engine-rules.md
  • ../../ai/rules/testing-rules.md
  • ../../ai/architecture/project-architecture.md
  • ../../ai/architecture/cube-engine.md
  • ../../ai/glossary/cube-terms.md

This file is compiled from canonical AI knowledge files. Edit canonical files under ai, then run npm run ai:sync.

Compiled AI Skill: cube-engine

Canonical Skill: ai/skills/cube-engine.md

Cube Engine

Use this skill when adding or changing the Rust cube representation, moves, notation, scrambles, or cube validation.

Goal

Build the pure Rust engine first, using cubie representation and deterministic behavior that later search algorithms can trust.

Read First

  • ai/rules/cube-engine-rules.md
  • ai/rules/testing-rules.md
  • ai/architecture/project-architecture.md
  • ai/architecture/cube-engine.md
  • ai/glossary/cube-terms.md

Workflow

  • Keep work inside crates/cube-engine unless a current boundary requires otherwise.
  • Start with cubie state invariants before adding higher-level algorithms.
  • Keep notation parsing and state mutation separate.
  • Add tests for solved state, move/inverse behavior, and invalid notation as behavior appears.
  • Fail explicitly for bootstrap placeholders rather than silently producing incorrect cube states.

Expected Output

  • Primary state remains corner/edge permutation and orientation.
  • Move behavior is reversible and tested when implemented.
  • No JavaScript visualization dependency enters the Rust engine.

Verification

  • Run cargo test -p cube-engine when Rust is installed.
  • If Rust is unavailable, state the environment blocker clearly.

Referenced Context

Reference: ai/rules/cube-engine-rules.md

Cube Engine Rules

Rules for the Rust cube engine.

Always

  • Use cubie representation as the primary state model: corner permutation, corner orientation, edge permutation, and edge orientation.
  • Keep move application pure and deterministic.
  • Make every implemented move reversible and test the inverse path.
  • Validate state invariants before solver algorithms depend on them.
  • Keep notation parsing separate from state mutation.
  • Keep serialization explicit and stable once external consumers exist.
  • When adding puzzles beyond 3x3, keep each puzzle's state representation, move model, notation parser, validator, and solver strategy puzzle-specific.

Read the full file on GitHub · 273 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 2d ago First seen · 273 lines · 2,911 tokens per session scan A aa179780260d

Subscribe to this mod's changes

rubiks-cube-solver cube-engine.instructions.md is an instructions file published in the GitHub repository williamisnotdefined/rubiks-cube-solver (4 stars, last pushed 8d ago), licensed MIT. It adds 2,911 tokens to every session, about $0.0146 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-31.

Related

Other instructions, from other repositories

spec-kit AGENTS.md

AGENTS.md instructions for github/spec-kit, covering agents.md, about spec kit and specify, quickstart — add a new integration in 5 steps, integration architecture and integrationmanifest — file tracking.

github/spec-kit · 7,104 tokens

vscode buildNext.instructions.md

Working notes and architecture documentation for the new esbuild-based build system in build/next. Use when making changes to the new build pipeline (transpile/bundle commands, NLS plugin, source-map handling, resource copying, or self-hosting watch tasks).

microsoft/vscode · 6,785 tokens

codex AGENTS.md

AGENTS.md instructions for openai/codex, covering rust/codex-rs, the codex-core crate, code review rules, crate api surface and model visible context.

openai/codex · 5,182 tokens

langchain AGENTS.md

AGENTS.md instructions for langchain-ai/langchain, covering global development guidelines for the langchain monorepo, corridor security analysis, project architecture and context, monorepo structure and development tools & commands.

langchain-ai/langchain · 4,345 tokens

vscode oss-third-party-notices.instructions.md

Instructions for microsoft/vscode, covering vs code oss third-party-notices pipeline, architecture, pipeline flow in ci, applying the notice (cutover) and fallback chain (never fail the build).

microsoft/vscode · 5,001 tokens

next.js AGENTS.md

Instructions for vercel/next.js, covering next.js development guide, codebase structure, monorepo overview, core package: packages/next and other important packages.

vercel/next.js · 7,296 tokens