Skip to main content

CLI

DocStatic provides a set of scripts to help you generate, serve, and deploy your website.

{
  // ...
  "scripts": {
    "docusaurus": "docusaurus",
    "dev": "tinacms dev -c \"docusaurus start\"",
    "start": "docusaurus start",
    "generate-media-index": "node scripts/generate-media-index.js",
    "generate-git-identity": "node scripts/generate-git-identity.js",
    "generate-files": "node scripts/generate-file-list.js",
    "update-theme-css": "node scripts/update-theme-css.js",
    "prebuild": "yarn generate-media-index && yarn generate-files && yarn update-theme-css && yarn generate-git-identity",
    "predev": "yarn generate-media-index && yarn generate-files && yarn update-theme-css && yarn generate-git-identity",
    "build": "tinacms build && docusaurus build",
    "build-local": "tinacms build --local --skip-indexing --skip-cloud-checks && docusaurus build",
    "swizzle": "docusaurus swizzle",
    "deploy": "docusaurus deploy",
    "setup-git-hooks": "git config core.hooksPath .githooks && chmod +x .githooks/pre-commit",
    "clear": "docusaurus clear",
    "serve": "docusaurus serve",
    "write-translations": "docusaurus write-translations",
    "write-heading-ids": "docusaurus write-heading-ids",
    "gen-api-docs": "docusaurus gen-api-docs",
    "clean-api-docs": "docusaurus clean-api-docs",
    "gen-graphql": "docusaurus docs:generate:graphql",
    "gen-api-docs:version": "docusaurus gen-api-docs:version",
    "clean-api-docs:version": "docusaurus clean-api-docs:version",
    "lint": "biome check apis/ config/ reuse/ scripts/ src/ static/ tina/",
    "lint:fix": "biome check apis/ config/ reuse/ scripts/ src/ static/ tina/ --fix",
    "mcp:install": "cd mcp-server && npm install",
    "mcp:build": "cd mcp-server && npm run build",
    "mcp:dev": "cd mcp-server && npm run dev",
    "mcp:start": "cd mcp-server && npm start"
  }
}

DocStatic CLI commands​

To invoke the commands, use yarn. For example, yarn dev.

Key DocStatic scripts:​

  • dev: Start development server with TinaCMS integration
  • build: Build for production (runs TinaCMS build then Docusaurus build)
  • build-local: Build locally without cloud features
  • generate-media-index: Generate index of media files
  • generate-git-identity: Generate git identity information
  • generate-files: Generate file lists for the application
  • update-theme-css: Update theme CSS files
  • mcp:install: Install Model Context Protocol server dependencies
  • mcp:build: Build the MCP server from TypeScript
  • mcp:dev: Start MCP server in development mode with auto-restart
  • mcp:start: Start the compiled MCP server for AI assistant integration

For more information about the MCP server, see MCP Server Integration.

These commands are built on top of standard Docusaurus commands described in CLI in the Docusaurus documentation:

  • docusaurus
  • start
  • build
  • swizzle
  • deploy
  • clear
  • serve
  • write-translations
  • write-heading-ids

Automated commands​

These commands are run automatically at build time or when starting the dev server:

  • generate-files
  • prebuild
  • predev

API commands​

  • clean-api-docs
  • gen-api-docs
  • gen-graphql

For more information on the OpenAPI commands, refer to CLI Usage in the Docusaurus OpenAPI Plugin documentation.

For more information on the GraphQL command, refer to Usage in the Docusaurus GraphQL Plugin documentation.

Linting commands​

For more information about the linting commands, refer to CLI in the Biome documentation.