ionworks

Ionworks Agentic Toolkit

Agent-ready skills for battery R&D workflows on the Ionworks platform. Give your coding agent the context it needs to ingest cycling data, organize cell characterization, run simulations, and structure research projects — without hand-holding on endpoints, schemas, or conventions.

What it does

• 8 action-oriented skills covering the full R&D loop: install, discovery, data processing, upload, cell management, simulations, simple pipelines, project structure.
• Live schema grounding. Skills direct agents to query /discovery/capabilities so field names, enums, and units always match the deployed API — not a static reference that drifts.
• Plain-Markdown skill files. Each skill is a single SKILL.md with YAML frontmatter. No runtime. Any agent that understands the skill convention (Codex, Claude Code, Cursor, Gemini CLI, GitHub Copilot, Anthropic SDK agents, custom frameworks) can load them.
• Self-contained. No MCP server required. Skills drive the official Ionworks Python SDK; all they need is an IONWORKS_API_KEY.
• Optional slash commands for Claude Code users who want one-shot entry points.

Install

Quick install — paste this into your coding agent

Drop the block below into Claude Code, Codex, Cursor, Gemini CLI, GitHub Copilot, or any agent with shell access. It auto-detects which agent it's running in, picks the right install path, verifies the SDK is set up, and tells you what's missing.

Install the Ionworks agentic toolkit for me.

Fetch https://raw.githubusercontent.com/ionworks/ionworks-skills/main/README.md
and follow the install instructions there. Pick the path that matches the
agent you (the assistant) are running in — Claude Code, Codex, Cursor, Gemini CLI, GitHub Copilot, or another.

After install, verify the skills are accessible, make sure `ionworks-api` is in
the Python env I'll be running code in, and check whether IONWORKS_API_KEY
is set in my shell. If the key is missing, tell me to grab one from
https://app.ionworks.com/dashboard/account — don't try to mint one yourself.

Finally, invoke the `install` skill to run the SDK's self-check, then report
what you did and anything I still need to do by hand.

Manual install paths

If you'd rather drive it yourself, the fastest path for any agent uses the skills CLI from vercel-labs/skills — auto-detects your agent and installs to the right directory:

npx skills add ionworks/ionworks-skills        # project-level (./.claude/skills/, etc.)
npx skills add ionworks/ionworks-skills -g     # user-level (~/.claude/skills/, etc.)

Add --all to install every skill non-interactively, or --skill <name> to install just one. npx skills update -g keeps the install in sync with new releases.

Other install paths

Platform	Install path	Notes
Cursor	npx skills add ionworks/ionworks-skills -g	Natively supported by npx skills; copies SKILL.md files to ~/.cursor/skills/.
GitHub Copilot (VS Code / CLI)	npx skills add ionworks/ionworks-skills -g	Copilot auto-discovers SKILL.md from .agents/skills/ and .github/skills/ — no extra config needed.
Codex (plugin)	Local marketplace install — see below	Uses .codex-plugin/plugin.json and exposes the skills/*/SKILL.md files to Codex.
Gemini CLI (extension)	Clone + gemini extensions install ~/ionworks-skills — see below	Uses gemini-extension.json + GEMINI.md; skills load as passive context on every session.
Claude Code (plugin)	/plugin marketplace add ionworks/ionworks-skills → /plugin install ionworks	Native plugin install. Adds slash commands and the SessionStart skill-index hook in addition to the skills.
Claude Agent SDK / API	Skill(path=".../skills/<skill-name>") or copy SKILL.md files into your agent's skills directory	Works with any Anthropic-SDK agent that implements the Skill tool.
Manual	Clone this repo, copy any skills/<skill-name>/SKILL.md into your agent's skills or context directory	Frontmatter descriptions act as triggers; bodies are general-purpose guidance.

Codex install

Codex requires a marketplace directory that references one or more plugins. This repository ships .codex-plugin/plugin.json but not a marketplace manifest, so install via a small local scaffold:

# 1. Clone the public skills repo somewhere stable
git clone https://github.com/ionworks/ionworks-skills.git ~/ionworks-skills