⚠️ Experimental: This wizard is still in an experimental phase. If you have any feedback, please drop an email to sagnik [at] worqhat [dot] com.WorqHat wizard ✨ The WorqHat wizard helps you quickly add WorqHat to your project using AI. Works with JavaScript/TypeScript, plus guidance for Python and Ruby projects.
worqhat/config.*
, worqhat/workflows.*
, and worqhat/db.*
(when applicable).WORQHAT.md
per generated file.gh
) for automatic PR creationworqhat-wizard
.WORQHAT.md
guide.gh
is available).WORQHAT.md
: A living guide with project snapshot and usage docs.worqhat/config.*
: WorqHat client config and environment setup guidance.worqhat/workflows.*
: Starter workflow helpers (examples avoid importing/passing the client explicitly).worqhat/db.*
: Optional database helpers when you select Database.WORQHAT.md
for the generated files.
Option | Type | Default | Description |
---|---|---|---|
—help | boolean | — | Show help |
—version | boolean | — | Show version number |
—force-install | boolean | false | Force install packages even if peer dependency checks fail |
—logout | boolean | — | Remove saved API key |
—branch-prefix (prefix) | string | worqhat-wizard | Prefix for the new git branch created by the wizard (format: —branch-prefix <prefix> or —branch-prefix=<prefix>) |
<prefix>/<YYYY-MM-DD-HHMMSS>
(default prefix: worqhat-wizard
).origin
.gh
) is available, opens a pull request and prints a confirmation.WORQHAT.md
includes an Environment Setup section explaining how to set WORQHAT_API_KEY
via shell or .env
..env
files with care and add them to .gitignore
.git init
) or run in an existing repo. The wizard can still generate files without Git.origin
is set and you have permissions. Install gh
to enable automatic PR creation.--force-install
to bypass strict peer checks, or install dependencies manually as prompted.WORQHAT_API_KEY
in your shell/.env. Use --logout
to remove the stored key.