Get Started
Your agent needs the Filestar CLI, filestarcli, on the computer it runs on. Install it one of these ways, then add Filestar to your agents.
1. Install the CLI
npm (recommended for agents)
With Node.js 18 or later:
npm install -g filestarThis installs only the CLI, as the commands filestarcli and filestar. It works on Windows, macOS (Intel and Apple silicon) and Linux x64. An agent can also run it without installing it first:
npx -y filestar -i photo.heic -c "convert to jpg" --json.NET tool
With the .NET 10 SDK:
dotnet tool install -g FilestarThe Filestar app
The Filestar app puts filestarcli on your PATH on Windows and macOS. That CLI uses the app's plan; see Plans and Limits.
Open a new terminal after installing, then check that it works:
filestarcli version
filestarcli doctordoctor checks that this computer is ready to run skills and says what to fix when it is not.
2. Add Filestar to your agents
filestarcli agent installThe CLI finds the agents on this computer and shows, for each one, what it would add and to which file. Nothing is written until you confirm. Each agent gets the integration it handles best:
- A skill for Claude Code and Codex: a
SKILL.mdfile that tells the agent how to runfilestarcli. - The MCP server for Claude Desktop, Cursor, VS Code, Gemini CLI, GitHub Copilot CLI, opencode and Windsurf.
Every file it edits is copied to a .bak file first. To see what is installed, run filestarcli agent list; to remove Filestar again, run filestarcli agent uninstall.
An agent can set itself up without questions:
filestarcli agent install --agent claude-code --yes --jsonIn the Filestar app, the same choices are under Help › Use With AI Agents….
If you prefer to add Filestar by hand, each agent's page shows the exact entry: Claude Code, Codex, Claude Desktop, Cursor, VS Code, Gemini CLI, GitHub Copilot CLI, other agents.
3. Ask your agent
Restart the agent (or start a new session) so it picks Filestar up, then ask it something like:
- "Convert the HEIC photos in my Downloads folder to JPG."
- "Resize these images to 800 pixels wide."
- "Merge these PDFs into one file."
The agent runs filestarcli and tells you where the new files are. Your files never leave your computer for a local skill.
Sandboxes, CI and containers
Where nobody can run a command by hand, set your licence key in the environment and the CLI registers on its first run:
FILESTAR_LICENSE_KEY=<your licence key>All npm and .NET tool installs of one licence count as one device together, so containers do not use up your devices.