Skip to content

asimawdah/SkillMint

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

93 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

SkillMint

Make any codebase AI-agent ready with one command.

SkillMint is a lightweight Python CLI that detects your project stack and installs practical AI skills, rules, and instruction files for coding agents.

It helps Claude Code, Cursor, GitHub Copilot, Codex, Hermes, Cline, Roo Code, Aider, and similar AI coding agents understand your repository before they edit it.

Why SkillMint?

AI coding agents work better when your repository clearly explains:

  • What stack and framework the project uses.
  • Which commands install, run, test, and build the project.
  • Which files and directories should not be edited.
  • Which framework conventions should be followed.
  • Which instruction files should exist for different AI tools.

SkillMint creates that setup automatically.

Install

SkillMint is available on PyPI:

pip install skillmint

Verify the installation:

skillmint --version

Quick start

Run SkillMint inside any project directory:

cd your-project
skillmint

SkillMint will:

  1. Scan the current project.
  2. Detect the stack and framework.
  3. Show recommended AI skills.
  4. Ask what you want to install.
  5. Generate AI instruction files.
  6. Copy or generate skills into the project.

Preview the planned changes without writing files:

skillmint --dry-run

For non-interactive preview in another project directory:

skillmint --root /path/to/project --dry-run

For non-interactive usage:

skillmint --yes

To generate the instruction bundle in a custom folder:

skillmint --yes --instructions-dir docs/project-ai

To verify an existing generated instruction bundle before trusting it in CI or automation:

skillmint --verify-instructions

For a custom bundle folder:

skillmint --root /path/to/project --instructions-dir docs/project-ai --verify-instructions

To avoid downloading external skills and only generate local skills:

skillmint --no-external

To scan another directory:

skillmint --root /path/to/project

By default, SkillMint skips existing generated files so it does not overwrite project-specific instructions that were edited by hand. To intentionally replace existing files, use:

skillmint --force

For CI or scripted setup where overwriting is expected:

skillmint --yes --force

Safe workflow

SkillMint should make AI-assisted development safer, not noisier. A normal run should follow this flow:

  1. Inspect the project before writing files.
  2. Explain the detected stack and recommended instruction files.
  3. Preview planned output first with skillmint --dry-run when reviewing a new repository.
  4. Ask for confirmation before installing external skills.
  5. Skip existing generated files unless --force is passed.
  6. Prefer small, readable generated files over large hidden configuration.
  7. Keep generated content easy to review in Git before it is committed.
  8. Run skillmint --verify-instructions before CI or automation consumes a generated bundle.

Recommended review command after running SkillMint:

git diff -- AGENTS.md CLAUDE.md .cursor/rules/project.mdc .github/copilot-instructions.md .ai/instructions .ai/skills

If the generated files do not match the project, edit them before giving an AI agent permission to modify code.

Generated files

Depending on your project, SkillMint can generate:

AGENTS.md
CLAUDE.md
.cursor/rules/project.mdc
.github/copilot-instructions.md
.ai/instructions/README.md
.ai/instructions/STACKS.md
.ai/instructions/COMMANDS.md
.ai/instructions/SAFE_CHANGES.md
.ai/instructions/NEXT_STEPS.md
.ai/instructions/MANIFEST.json
.ai/skills/<stack>/SKILL.md

These files give AI coding agents clear project-specific context and safer editing rules.

Generated instruction files include a Detection Evidence section when SkillMint knows why a stack was selected. This makes scanner results easier to review before trusting generated AI instructions.

The .ai/instructions/ bundle keeps the detected project profile, commands, safe-change rules, next-step checks, and machine-readable manifest in one clear output folder. See docs/AI_INSTRUCTION_BUNDLE.md for details and examples.

Example:

## Detection Evidence

### React

- package.json includes react

Supported stacks

SkillMint currently supports detection and skill generation for:

  • Flutter / Dart
  • React
  • Node.js / JavaScript / TypeScript
  • Next.js
  • Vue
  • Nuxt
  • Svelte / SvelteKit
  • Angular
  • Python
  • FastAPI
  • Django
  • Flask
  • Laravel / PHP
  • Go
  • Rust
  • Docker
  • GitHub Actions

Trusted external skills

For supported ecosystems, SkillMint can suggest trusted external skill sources, such as:

  • Flutter official skills: https://github.com/flutter/skills
  • Dart official skills: https://github.com/dart-lang/skills

External downloads require confirmation. SkillMint does not silently download external skills in the normal interactive flow.

Example

Inside a React project:

skillmint

SkillMint may generate:

AGENTS.md
CLAUDE.md
.cursor/rules/project.mdc
.github/copilot-instructions.md
.ai/instructions/README.md
.ai/instructions/STACKS.md
.ai/instructions/COMMANDS.md
.ai/instructions/SAFE_CHANGES.md
.ai/instructions/NEXT_STEPS.md
.ai/instructions/MANIFEST.json
.ai/skills/react/SKILL.md

The generated instructions include common commands, stack-specific rules, files to avoid, next-step checks, machine-readable manifest metadata, and guidance for AI-assisted edits.

Development

Clone the repository:

git clone https://github.com/asimawdah/SkillMint.git
cd SkillMint

Install locally with development dependencies:

python -m pip install -e .[dev]

Run tests:

pytest -q

Run the CLI locally:

python -m skillmint --version
python -m skillmint --root .
python -m skillmint --verify-instructions

Project goals

SkillMint is designed to stay:

  • Simple: one command should be enough for the main flow.
  • Lightweight: no heavy runtime dependencies.
  • Safe: clear confirmation before external downloads.
  • Practical: generated files should be readable and easy to review.
  • Agent-friendly: useful for modern AI coding workflows.

License

MIT

About

Generate AI coding skills and project instructions automatically for better AI-assisted development.

Topics

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages