#CLI

The gittydocs CLI packages the docs app into a local workflow.

#Install

Use npx (no install):

npx gittydocs@latest --help

Or install globally:

npm i -g gittydocs
gittydocs --help

#Commands

#gittydocs new [folder]

Create a new docs folder scaffold:

gittydocs new docs
cd docs
gittydocs dev docs

If you omit the folder, the CLI will prompt you for a name and scaffold type:

gittydocs new

For the fully customizable app (ejected):

gittydocs new docs --ejected
cd docs
bun install
bun run dev

#gittydocs dev <GITTYDOCS_SOURCE>

Run the local dev server:

gittydocs dev ./docs

If ./docs/.env exists, it is loaded automatically (or use --env).

Hot reload is automatic for local sources. Edit .md/.mdx, gittydocs.jsonc, theme.css, or files in [static] or [images] and the browser refreshes. For GitHub URLs, restart gittydocs dev to pull the latest content.

#gittydocs build <GITTYDOCS_SOURCE>

Build a static site:

gittydocs build ./docs

Output defaults to dist/client (override with --out).

#gittydocs deploy

Generate GitHub Actions workflow(s):

gittydocs deploy --ghpages

Commit the generated workflow(s) in .github/workflows/.

#gittydocs recache

Clear the cached web runtime used by gittydocs dev/build:

gittydocs recache

This removes the current version's cached runtime. The next gittydocs dev/build recreates it. Use --all to clear every cached version.

#Requirements

gittydocs dev and gittydocs build require bun.