warpy-iconforge
v1.0.9
Published
CLI tool to install AI-generated icon packs as React components
Maintainers
Readme
IconForge CLI
Install AI-generated icon packs as React components directly into your project.
Installation
You can use IconForge directly with npx (no installation required):
npx iconforge <command>Or install it globally:
npm install -g iconforgeQuick Start
1. Generate Icons
Visit iconforge.sh and generate your icon pack using AI.
2. Get Your MCP Token
Go to iconforge.sh/mcp-tokens and create an MCP token.
3. Authenticate
npx iconforge authPaste your MCP token when prompted.
4. List Your Packages
npx iconforge listThis shows all your available icon packages with their IDs.
5. Install Icons
npx iconforge add <package-id>The CLI will:
- Fetch your icons
- Detect if you're using TypeScript
- Ask where to save the file
- Generate a React component file with all your icons
Usage
Commands
| Command | Description |
| -------------------- | -------------------------------- |
| iconforge auth | Authenticate with your MCP token |
| iconforge logout | Remove saved authentication |
| iconforge list | List your icon packages |
| iconforge add <id> | Install an icon package |
Example Output
The CLI generates a React component file like this:
TypeScript (icons.tsx):
import * as React from "react";
interface IconProps extends React.SVGProps<SVGSVGElement> {
size?: number | string;
}
export const HomeIcon = ({ size = 24, ...props }: IconProps) => (
<svg
width={size}
height={size}
viewBox="0 0 24 24"
fill="none"
stroke="currentColor"
strokeWidth="2"
strokeLinecap="round"
strokeLinejoin="round"
{...props}
>
<path d="M3 9l9-7 9 7v11a2 2 0 0 1-2 2H5a2 2 0 0 1-2-2z" />
</svg>
);
export const SettingsIcon = ({ size = 24, ...props }: IconProps) => (
// ...
);Using the Icons
import { HomeIcon, SettingsIcon } from "./components/icons";
function App() {
return (
<div>
<HomeIcon size={24} className="text-blue-500" />
<SettingsIcon size={32} />
</div>
);
}Icon Props
All generated icons accept the following props:
| Prop | Type | Default | Description |
| ---------- | ------------------ | ------- | -------------------------------------------------------- |
| size | number \| string | 24 | Width and height of the icon |
| ...props | SVGProps | - | All standard SVG props (className, style, onClick, etc.) |
Configuration
IconForge stores its configuration in ~/.iconforge/config.json.
Custom API URL
For self-hosted instances, you can set a custom API URL:
# The config is stored in ~/.iconforge/config.json
# Edit it to add: "apiUrl": "https://your-instance.com"Troubleshooting
"Not authenticated" error
Run iconforge auth and enter your MCP token.
"Package not found" error
- Check that the package ID is correct
- Packages expire after 7 days - generate new icons if expired
- Run
iconforge listto see available packages
"Token invalid" error
Your token may have expired. Create a new token at iconforge.sh/mcp-tokens and run iconforge auth again.
Requirements
- Node.js 18 or higher
- React project (for using generated components)
License
MIT
