Reference
CLI reference
Commands, arguments, and supported options.
On this page
create
Create a local starter without provider login, then optionally continue into GitHub, CI/CD, and deployment. Non-interactive creation finishes locally.
forjex create [name] --template <template> [--no-install] [--no-setup] [--ai]
forjex create my-app --template nextjs
forjex create my-api --template python --no-install- name: a new folder name. If omitted, the CLI asks for it.
- --template: nextjs, react, vue, python, go, or rust. If omitted, choose interactively.
- --no-install: skip the npm installation offer for Node starters.
- --no-setup: finish locally without offering GitHub, CI/CD, and deployment.
- --ai: offer an AI commit message if you continue into GitHub setup. Run forjex ai configure or set your provider’s key environment variable.
Supported aliases are vite-react, python-fastapi, go-api, and rust-app.
forge
Choose between a new starter and the current local project, then optionally set up GitHub.
forjex forge [name] [--template <template>] [--no-install] [--ci] [--vercel] [--ai]
forjex forge
forjex forge my-app --template react --ci --vercel- A name or --template starts the new-project path.
- --ci enables CI/CD if you continue to GitHub setup.
- --vercel enables Vercel if you continue to GitHub setup for a supported frontend.
- Without a name or template, choose a new starter or the existing local project.
- After generating a starter, GitHub setup is optional. These flags do not publish without the interactive setup.
push and AI commit messages
Commit staged changes and push the current branch to its existing origin. If nothing is staged, interactive mode offers to stage the changes shown. Existing commits keep their messages.
forjex ai configure
forjex push --ai
forjex push -m "feat: add project search"Run forjex ai configure to choose your AI provider and model and optionally save an API key. Saved settings live in ~/.forjex/ai.json; a saved key is plaintext in a user-only file. Alternatively set your selected provider’s API-key environment variable in your terminal. Environment variables override saved settings. Optionally set FORJEX_AI_MODEL (OpenAI default: gpt-4.1-mini; other providers need a model ID). Review, edit, or regenerate before committing. Sensitive paths and recognized secrets are filtered from bounded text diffs; review your changes for other confidential content. AI failure leaves manual messages available. Non-interactive commits require staged files and --message.
The cloud wizard also offers AI messages before forging. Connect GitHub and supply your AI provider, model ID, and API key in the commit-message panel. The key stays in page memory and is used by our server only for generation; it is not saved. Cloud summarizes its planned additions, while the CLI can summarize your local staged changes.
AI configuration
forjex ai configure
forjex ai status
forjex ai clear- OpenAI: FORJEX_AI_PROVIDER=openai, key variable OPENAI_API_KEY.
- OpenRouter: FORJEX_AI_PROVIDER=openrouter, key variable OPENROUTER_API_KEY.
- Google Gemini: FORJEX_AI_PROVIDER=gemini, key variable GEMINI_API_KEY.
- Grok (xAI): FORJEX_AI_PROVIDER=grok, key variable XAI_API_KEY.
- Anthropic Claude: FORJEX_AI_PROVIDER=anthropic, key variable ANTHROPIC_API_KEY.
- Mistral: FORJEX_AI_PROVIDER=mistral, key variable MISTRAL_API_KEY.
Configure selects a provider and model and asks before saving a key to a plaintext file with user-only permissions. Status shows the effective model and key source without revealing the key. Clear removes saved AI settings; environment variables still apply. Saving AI settings does not change GitHub or Vercel credentials.
Account commands
forjex login
forjex login --token <github-personal-access-token>
forjex whoami
forjex logoutLogin connects the CLI to your account. whoami reports the saved identity; logout clears locally saved CLI credentials. See authentication.
sync
forjex syncFetch synchronized projects from your Forjex account. See dashboard and sync for connection and persistence requirements.
Help and version
forjex --help
forjex create --help
forjex forge --help
forjex --version