[{"data":1,"prerenderedAt":16},["ShallowReactive",2],{"clay-page:\u002F4.x\u002Fde\u002Fpublishing\u002Fcli-reference":3},{"html":4,"toc":5,"description":12,"hero":13,"list":14,"socialImage":15},"\u003Ch1 id=\"cli-reference\">CLI Reference\u003C\u002Fh1>\n\u003Cp>Every command and option, as the help of Clay 4.0.0 lists them. This page is \u003Ca href=\"\u002Fclay-example-repo\u002F4.x\u002Fde\u002Fwriting\u002Fgenerated-docs\" data-route=\"\u002F4.x\u002Fde\u002Fwriting\u002Fgenerated-docs\">generated\u003C\u002Fa> before every build by \u003Ccode>scripts\u002Fcli-reference.mjs\u003C\u002Fcode>; the \u003Ca href=\"\u002Fclay-example-repo\u002F4.x\u002Fde\u002Fpublishing\u002Fcommands\" data-route=\"\u002F4.x\u002Fde\u002Fpublishing\u002Fcommands\">commands\u003C\u002Fa> page explains them.\u003C\u002Fp>\n\u003Ch2 id=\"clay\">\u003Ca class=\"heading-anchor\" href=\"#clay\" aria-label=\"Link zu diesem Abschnitt\" data-route=\"#clay\">#\u003C\u002Fa>clay\u003C\u002Fh2>\n\u003Cdiv class=\"code-block has-title\">\u003Cdiv class=\"code-title\">\u003Ci class=\"fa-regular fa-file-lines\" aria-hidden=\"true\">\u003C\u002Fi>\u003Cspan>clay --help\u003C\u002Fspan>\u003C\u002Fdiv>\u003Cpre class=\"shiki shiki-themes light-plus dark-plus\" style=\"--shiki-light:#000000;--shiki-dark:#D4D4D4;--shiki-light-bg:#FFFFFF;--shiki-dark-bg:#1E1E1E\" tabindex=\"0\">\u003Ccode>\u003Cspan class=\"line\">\u003Cspan>Clay 4.0.0 - documentation sites from Markdown\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>Usage: clay <command> [options]\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>Commands:\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>  dev       Start a development server with live reload\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>  build     Build the static site into <out>\u002Fpublic\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>  preview   Serve the built site like a static host would\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>  edit      Edit pages, folders, their front matter and order, and clay.yaml: interactively,\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>            or one change per command for scripts and AI agents (\"clay edit help\")\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>  check     Check links, translations and settings without building; --json for programs\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>  version   Save the latest docs as an older version in docs\u002F<name>\u002F: clay version <name>\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>Options:\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>  --root <dir>   Docs project with clay.yaml and docs\u002F (default: current directory)\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>  --out <dir>    Output directory (default: <root>\u002Fpublish)\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>  --port <port>  Port for dev and preview (default: 3000 and 4173)\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>  --host         Listen on all interfaces, not just localhost\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>  --strict       build: fail on warnings such as broken links or config typos\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>  --verbose      build and dev: show the full Nuxt output instead of the progress\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>  --json         edit and check: print the result as JSON\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>  --yes          version: move docs\u002F into docs\u002Flatest\u002F without asking (the first version)\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>  -h, --help     Show this help (clay edit --help: the edit commands)\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>  -v, --version  Show the version\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>Environment overrides for clay.yaml: CLAY_TITLE, CLAY_BASE_URL, CLAY_SITE_URL, CLAY_FONTAWESOME_KIT\u003C\u002Fspan>\u003C\u002Fspan>\u003C\u002Fcode>\u003C\u002Fpre>\u003Cbutton type=\"button\" class=\"copy-code btn btn-sm btn-square btn-ghost\" title=\"Code kopieren\" aria-label=\"Code kopieren\">\u003Ci class=\"fa-solid fa-copy\">\u003C\u002Fi>\u003C\u002Fbutton>\u003C\u002Fdiv>\n\u003Ch2 id=\"clay-edit\">\u003Ca class=\"heading-anchor\" href=\"#clay-edit\" aria-label=\"Link zu diesem Abschnitt\" data-route=\"#clay-edit\">#\u003C\u002Fa>clay edit\u003C\u002Fh2>\n\u003Cdiv class=\"code-block has-title\">\u003Cdiv class=\"code-title\">\u003Ci class=\"fa-regular fa-file-lines\" aria-hidden=\"true\">\u003C\u002Fi>\u003Cspan>clay edit help\u003C\u002Fspan>\u003C\u002Fdiv>\u003Cpre class=\"shiki shiki-themes light-plus dark-plus\" style=\"--shiki-light:#000000;--shiki-dark:#D4D4D4;--shiki-light-bg:#FFFFFF;--shiki-dark-bg:#1E1E1E\" tabindex=\"0\">\u003Ccode>\u003Cspan class=\"line\">\u003Cspan>clay edit - change the docs from the command line\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>Without a command, \"clay edit\" opens the interactive editor (needs a terminal).\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>With a command, it does one change and exits, for scripts and AI agents.\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>Paths are relative to the docs: docs\u002F, or with versions docs\u002Flatest\u002F (docs\u002F<name>\u002F with --docs-version):\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>  guides\u002Fsetup.md   a page            \".md\" may be left out: guides\u002Fsetup\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>  guides            a folder          its title and order live in guides\u002Findex.md\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>  index.md          the start page    docs\u002Findex.md\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>  \"\"                the top level     where a folder is expected\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>Commands:\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>  list                                 Every page and folder: path, title, icon, order, URL\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>  show <path>                          All front matter of one page or folder\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>  set <path> <field>=<value>...        Set front matter; an empty value removes the field\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>                                       fields: title icon description order list hero\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>  new page <folder> <title>            Create a page (file name from the title, or --slug)\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>  new folder <parent> <title>          Create a folder with an index.md\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>  move <path> <folder>                 Move a page (with its translations) or a folder\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>  rename <path> <new-name>             Rename the file or folder (without \".md\")\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>                                       --redirect: the old address keeps leading to the page\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>  order <path> <position>              Put an entry at a position (1 = first) in its folder\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>  delete <path> --yes                  Delete a page with its translations, or a folder\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>  translate <path> --lang <code>       Start a translation: copy the original to <name>.<code>.md\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>  config                               All settings of clay.yaml with their keys\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>  config get <key>                     One setting, e.g. title or navbar.source.link\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>  config set <key> <value>             Change a setting; keys of links: navbar.links.<n>.name|icon|link\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>  config unset <key>                   Remove a setting\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>  config add-link <name> <icon> <url>  Add a navbar link\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>  config remove-link <n>               Remove the n-th navbar link (1 = first)\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>Options:\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>  --json                Print the result as JSON (see below) instead of text\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>  --lang <code>         Work in a language other than the default (set, show, list, translate, config)\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>  --docs-version <name> Work in an older version in docs\u002F<name>\u002F\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>  --slug <name>         File or folder name for new and move (default: from the title or unchanged)\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>  --yes                 Confirm delete\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>  --redirect            move and rename: add the old address to the page's \"redirects\"\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>Examples:\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>  clay edit list --json\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>  clay edit set guides\u002Fsetup.md title=\"Setting up\" icon=\"fa-solid fa-wrench\" order=2\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>  clay edit set guides description=\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>  clay edit new page guides \"Upgrading\"\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>  clay edit move guides\u002Fsetup.md reference --redirect\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>  clay edit order guides\u002Fsetup.md 1\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>  clay edit set guides\u002Fsetup.md title=Einrichtung --lang de\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>  clay edit config set navbar.links.1.icon \"fa-solid fa-book\"\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>  clay check --json\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>Results:\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>  Changes are written right away, only to the files that change; comments and\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>  formatting stay. Moving, renaming and deleting do not rewrite links: the\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>  result lists the links that broke, so you can fix them. Run \"clay check\"\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>  afterwards: it reports broken links and settings without building the site.\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>  With --json, every command prints one object: {\"ok\": true, ...} with the\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>  command's result (\"written\": files changed, \"broken\": links that broke,\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>  \"moved\" and \"redirects\" for move and rename, and \"entries\", \"entry\" or\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>  \"settings\" for list, show and config), or\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>  {\"ok\": false, \"error\": \"...\"} when it fails.\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>Exit codes: 0 done, 1 failed or problems found (check), 2 wrong usage.\u003C\u002Fspan>\u003C\u002Fspan>\u003C\u002Fcode>\u003C\u002Fpre>\u003Cbutton type=\"button\" class=\"copy-code btn btn-sm btn-square btn-ghost\" title=\"Code kopieren\" aria-label=\"Code kopieren\">\u003Ci class=\"fa-solid fa-copy\">\u003C\u002Fi>\u003C\u002Fbutton>\u003C\u002Fdiv>\n",[6,9],{"id":7,"text":7,"level":8},"clay",2,{"id":10,"text":11,"level":8},"clay-edit","clay edit","Every command and option of clay, as its help lists them.",null,false,"\u002F_clay\u002Fsocial\u002F4.x\u002Fde\u002Fpublishing\u002Fcli-reference.png",1792666372836]