Artisaan Logo
Docs
Core Commands

Core Commands

Main workflow to generate and publish documentation with Artisaan CLI

Main workflow

Initialize the project

Creates the .artisaan/ folder and the base project configuration file.

artisaan init

Review configuration

Confirm language, project type, and search paths before generation.

.artisaan/config.json

Generate documentation

Processes your code and generates/updates documentation files.

artisaan docs generate

Sync to remote

Sends docs to the configured bucket/project, updating published pages.

artisaan docs sync

Main commands

CommandPurposeWhen to use
artisaan initInitializes local configurationFirst run in the repository
artisaan docs generateGenerates docs from your codeAfter project changes
artisaan docs syncPublishes/syncs remote docsAfter local validation

Run by operating system

artisaan init artisaan docs generate artisaan docs sync

Minimum recommended configuration

{
  "slug": "my-project",
  "language": "typescript",
  "project": "nextjs",
  "search_paths": [
    "app",
    "lib",
    "src"
  ],
  "ignore_paths": [
    "node_modules",
    "dist",
    ".next"
  ]
}

Common issues

missing field "slug"

This error occurs in artisaan docs sync when .artisaan/config.json does not contain the slug field.

Add "slug" to the .artisaan/config.json file.
Example: "slug": "my-project"

Empty or incomplete documentation

  • Check whether your source folders are listed in search_paths.
  • Confirm that relevant content is not blocked in ignore_paths.
  • Run artisaan docs generate again after adjustments.

Quick checklist

  • artisaan init executed in the correct repository.
  • .artisaan/config.json includes slug, language, and project.
  • search_paths covers the real source code folders.
  • artisaan docs generate completes without errors before artisaan docs sync.