Skip to content

Latest commit

 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

@funkai/cli

CLI for the funkai prompt SDK — codegen, lint, create, and setup commands for .prompt files.

npm version License

Features

  • ⚙️ Code generation — Generate typed TypeScript modules from .prompt files.
  • 🔍 Validation — Validate prompt files for undefined and unused variables.
  • Scaffolding — Create new .prompt files and partials with a single command.
  • 🔧 Project setup — Configure VSCode, .gitignore, and tsconfig.json interactively.

Install

npm install @funkai/cli

Usage

funkai prompts generate

Generate typed TypeScript modules from .prompt files.

funkai prompts generate --out .prompts/client --includes "src/agents/**"
Flag Description
--out Output directory for generated files
--includes Glob patterns to scan for .prompt files
--partials Custom partials directory
--silent Suppress output except errors

funkai prompts lint

Validate .prompt files without generating output.

funkai prompts lint --includes "src/agents/**"
Flag Description
--includes Glob patterns to scan for .prompt files
--partials Custom partials directory (default: .prompts/partials)
--silent Suppress output except errors

funkai prompts create

Scaffold a new .prompt file.

funkai prompts create my-agent
funkai prompts create my-agent --out src/agents/my-agent
Flag Description
--name Prompt name (kebab-case)
--out Output directory (defaults to cwd)
--partial Create as a partial in .prompts/partials/ (ignores --out)

funkai prompts setup

Interactive project configuration for .prompt file development.

funkai prompts setup

Configures VSCode file associations, Liquid extension recommendation, .gitignore entries, and tsconfig.json path aliases.

Documentation

See the Prompts concept and Prompts CLI reference for the full file format, library API, and guides.

License

MIT