Use VASPKIT to generate VASP helper inputs and post-process VASP outputs, including KPOINTS, band paths, DOS/band data, charge-density differences, planar averages, Bader charge coloring helpers…

Custom licenceAuto-check passed

Install Vaspkit

skills CLI
$ npx skills add JCLiuGroup/AI-Computational-Chemist --skill vaspkit -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install JCLiuGroup/AI-Computational-Chemist vaspkit --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/JCLiuGroup/AI-Computational-Chemist.git skills-src && mkdir -p .claude/skills && cp -r skills-src/tools/vaspkit .claude/skills/vaspkit && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
vaspkit
GitHub stars
145
Used in
1 other repo
Token cost
~1.1k tokens
SKILL.md length
435 words
Files
12 (incl. scripts, references)
Skills in repo
21
Repo updated
First seen
Licence
Custom licence

At a glance

Use VASPKIT to generate VASP helper inputs and post-process VASP outputs, including KPOINTS, band paths, DOS/band data, charge-density differences, planar averages, Bader charge coloring helpers…

  • Works in 5 steps: Use the vasp skill to confirm the… → Read running.md for the relevant VASPKIT… → Run uv run scripts/check_vaspkit.py… → …
  • SKILL.md covers Required inputs, Where to find what, Workflow and Hard guardrails
  • Runs Python scripts from its folder; calls uv

What it does

Vaspkit is an agent skill from JCLiuGroup/AI-Computational-Chemist. Use VASPKIT to generate VASP helper inputs and post-process VASP outputs, including KPOINTS, band paths, DOS/band data, charge-density differences, planar averages, Bader charge coloring helpers, real-space wavefunctions, partial/orbital charge density, work functions, elastic/EOS summaries, thermochemistry/free-energy corrections, AIMD trajectory post-processing (MSD, diffusion, VACF, VDOS, RDF/trajectory conversion), and batch analysis.

Its SKILL.md is about 1.1k tokens, which your agent loads only when the skill is triggered. The skill folder holds 14 other files, including scripts and reference files (for example `examples/README.md`, `references/aimd-postprocessing.md` and `references/dos-band.md`).

Example prompts

  • “/vaspkit”

Requirements

  • Python 3

Workflow steps

5 steps, taken from the first numbered list in SKILL.md.

  1. Use the vasp skill to confirm the upstream VASP run is technically valid.
  2. Read running.md for the relevant VASPKIT task family and required input files.
  3. Run uv run scripts/check_vaspkit.py RUNDIR; fix missing config, executable, or VASP files first.
  4. Run VASPKIT interactively for a new task; record every menu choice. Use run_vaspkit_task.py only after the input sequence is known.
  5. Validate generated outputs with validation.md; record source files, task IDs, energy reference, and version.

What it can do on your machine

Read from SKILL.md and the folder at commit e27b555. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    Ships 2 files in scripts/ (Python), which the agent can run.

    Shell commands in SKILL.md call:

    • uv

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    No URLs in SKILL.md. Its commands use uv, which can reach the network depending on how they are called.

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Vaspkit loads about 1.1k tokens when it runs, and up to ~11k if it reads all its reference files. Until then it costs about 113 tokens; SKILL.md has 435 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~113
When it runs · the whole SKILL.md, loaded when a task matches
~1.1k
With references · SKILL.md plus every file in references/, read only if the agent opens them
~11k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); the scripts in this folder are not scanned.

SKILL.md

Its licence (Custom licence) doesn't allow us to republish the file, so here is its outline and opening line. It has 435 words (~1,074 tokens).

“Use this skill when VASP data already exist or VASP helper inputs must be generated with VASPKIT. VASPKIT is an assistant around VASP; it does not replace the vasp skill's method selection, convergence checks, or provenance rules.”

— opening of SKILL.md by JCLiuGroup, Custom licence
name
vaspkit

Read the full SKILL.md on GitHub

Files

SKILL.md and 11 other files (scripts, references) in tools/vaspkit of JCLiuGroup/AI-Computational-Chemist.

  • SKILL.md
  • examples/README.md
  • references/aimd-postprocessing.md
  • references/dos-band.md
  • references/electronic-analysis.md
  • references/errors.md
  • references/resources.md
  • references/running.md
  • references/thermochemistry.md
  • references/validation.md
  • scripts/check_vaspkit.py
  • scripts/run_vaspkit_task.py

Open the folder on GitHubat commit e27b555

Used in 1 other repository

We found 2 copies of this SKILL.md (exact, near-identical or edited) in other folders, from 1 other GitHub owner. This page covers the copy in JCLiuGroup/AI-Computational-Chemist, which our catalogue first saw on October 7, 2026.

Compare with similar skills

Vaspkit next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Vaspkit compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Vaspkit this skillJCLiuGroup/AI-Computational-Chemist1451 repos~1.1kAutomated safety check: PassCustom licence
Search Inputthedaviddias/Front-End-Checklist74k—~402Automated safety check: PassMIT
Input Typesthedaviddias/Front-End-Checklist74k—~487Automated safety check: PassMIT
Paste Inputsthedaviddias/Front-End-Checklist74k—~443Automated safety check: PassMIT
Od Next Media Inputsnexu-io/open-design100k—~1.1kAutomated safety check: PassApache-2.0
Aria Input Field Namethedaviddias/Front-End-Checklist74k—~853Automated safety check: PassMIT

Similar skills

  • Search Input

    thedaviddias/Front-End-Checklist

    A skill your agent uses when reviewing templates, rendered HTML, or shared components related to Make search inputs accessible.

    74k GitHub stars~402 tokensUpdated 2 days ago
    Frontend & DesignAuto-check passed
  • Input Types

    thedaviddias/Front-End-Checklist

    A skill your agent uses when reviewing templates, rendered HTML, or shared components related to Use semantic input type attributes.

    74k GitHub stars~487 tokensUpdated 2 days ago
    Auto-check passed
  • Paste Inputs

    thedaviddias/Front-End-Checklist

    A skill your agent uses when reviewing rendered HTML, interactive components, or design-system patterns related to Allow pasting into form inputs.

    74k GitHub stars~443 tokensUpdated 2 days ago
    Frontend & DesignAuto-check passed
  • Od Next Media Inputs

    nexu-io/open-design

    Prepare required media inputs within an existing OD Next plan.

    100k GitHub stars~1.1k tokensUpdated today
    DevelopmentAuto-check passed
  • Aria Input Field Name

    thedaviddias/Front-End-Checklist

    A skill your agent uses when applies to all <input (except type=hidden), <textarea, <select, and custom form widgets using role=textbox, role=combobox, role=spinbutton, role=searchbox, or…

    74k GitHub stars~853 tokensUpdated 2 days ago
    Frontend & DesignAuto-check passed
  • Engine Test Helper Generator

    Donchitos/Claude-Code-Game-Studios

    Generates engine-specific test helper libraries with assertion utilities, factory functions and mocks, placed where the engine's test runner compiles them.

    26k GitHub stars~4.4k tokensUpdated 9 days ago
    Testing & QAAuto-check passed

More from JCLiuGroup/AI-Computational-Chemist

All 21 skills in this repo
  • Research Orchestrator

    JCLiuGroup/AI-Computational-Chemist

    Define and maintain machine-readable research project state for multi-stage computational chemistry work.

    145 GitHub starsUsed in 1 repo~1.8k tokens
    Auto-check passed
  • Comp Chem Workflow

    JCLiuGroup/AI-Computational-Chemist

    Entry point and controller for computational chemistry and materials workflows.

    145 GitHub starsUsed in 1 repo~1.4k tokens
    Auto-check passed
  • Cp2k

    JCLiuGroup/AI-Computational-Chemist

    Prepare, validate, run, and troubleshoot CP2K calculations for periodic and large molecular systems.

    145 GitHub starsUsed in 1 repo~1.7k tokens
    Auto-check passed
  • Deepmd

    JCLiuGroup/AI-Computational-Chemist

    DeePMD-kit and Deep Potential Molecular Dynamics workflows. An agent skill from JCLiuGroup/AI-Computational-Chemist.

    145 GitHub starsUsed in 1 repo~780 tokens
    Auto-check passed
  • Gaussian

    JCLiuGroup/AI-Computational-Chemist

    Prepare, validate, and troubleshoot Gaussian molecular quantum chemistry jobs.

    145 GitHub starsUsed in 1 repo~1k tokens
    Auto-check passed
  • Gromacs

    JCLiuGroup/AI-Computational-Chemist

    Prepare, validate, run, resume, troubleshoot, and analyze GROMACS molecular dynamics.

    145 GitHub starsUsed in 1 repo~1.7k tokens
    Auto-check passed

Questions about Vaspkit

What does Vaspkit do?

Use VASPKIT to generate VASP helper inputs and post-process VASP outputs, including KPOINTS, band paths, DOS/band data, charge-density differences, planar averages, Bader charge coloring helpers…. Vaspkit is an agent skill from JCLiuGroup/AI-Computational-Chemist. Use VASPKIT to generate VASP helper inputs and post-process VASP outputs, including KPOINTS, band paths, DOS/band data, charge-density differences, planar averages, Bader charge coloring helpers, real-space wavefunctions, partial/orbital charge density, work functions, elastic/EOS summaries, thermochemistry/free-energy corrections, AIMD trajectory post-processing (MSD, diffusion, VACF, VDOS, RDF/trajectory conversion), and batch analysis.

How do I install Vaspkit in Claude Code?

Run `npx skills add JCLiuGroup/AI-Computational-Chemist --skill vaspkit -a claude-code`. Or copy the skill folder (tools/vaspkit in JCLiuGroup/AI-Computational-Chemist) into .claude/skills/vaspkit in your project. Claude Code loads it when a task matches its description.

How do I install Vaspkit in Codex?

Run `npx skills add JCLiuGroup/AI-Computational-Chemist --skill vaspkit -a codex`. Or copy the skill folder (tools/vaspkit in JCLiuGroup/AI-Computational-Chemist) into .agents/skills/vaspkit in your project. Codex loads it when a task matches its description.

Can I use Vaspkit in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add JCLiuGroup/AI-Computational-Chemist --skill vaspkit -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/vaspkit, .gemini/skills/vaspkit, .github/skills/vaspkit and .opencode/skills/vaspkit in your project.

What does Vaspkit need to run?

Going by SKILL.md and its folder, Vaspkit needs Python for the scripts in its folder and the command-line tools its instructions call (uv). Our summary lists: Python 3.

Does Vaspkit access the network?

SKILL.md contains no URLs. Its commands use uv, which can reach the network depending on how they are called. This is read from the text; nothing was executed.

Is Vaspkit safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. The check reads SKILL.md only: the scripts in the folder are not scanned, so read them before running anything.

What licence does Vaspkit use?

Vaspkit has a licence file (the repository's licence) that doesn't match a standard licence. Read it on GitHub before reusing the skill.

How many tokens does Vaspkit use?

About 1.1k tokens (SKILL.md is roughly 4.3k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full. Its references folder adds about 9.9k tokens, read only when the agent opens those files.

What are the alternatives to Vaspkit?

Skills that share tags, products or a category with Vaspkit: Search Input (thedaviddias/Front-End-Checklist, 74k stars), Input Types (thedaviddias/Front-End-Checklist, 74k stars), Paste Inputs (thedaviddias/Front-End-Checklist, 74k stars) and Od Next Media Inputs (nexu-io/open-design, 100k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Vaspkit?

JCLiuGroup (a GitHub organization) maintains it in JCLiuGroup/AI-Computational-Chemist, which has 145 GitHub stars. The repository holds 21 skills in this directory. The repository was last updated on September 27, 2026.

Source: JCLiuGroup/AI-Computational-Chemist on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.