codex cli namespace
docs-builder codex --help
Build a documentation portal over multiple independent documentation sets, each with its own navigation.
Clone all repositories and build the portal in one step.
docs-builder codex __argh_root <config> [options]
<config>stringrequired-
Path to the codex.yml configuration file.
Constraints: symbolic links not allowed, must exist, extensions: yml, yaml, supports
~home expansion
--[no-]strict-
Treat warnings as errors.
Default:
false --[no-]fetch-latest-
Fetch the HEAD of each branch instead of the pinned ref.
Default:
false --[no-]assume-cloned-
Skip cloning; assume repositories are already on disk.
Default:
false --outputstring-
Output directory for the built portal. Defaults to .artifacts/codex/.
Constraints: symbolic links not allowed, supports
~home expansion --[no-]serve-
Serve the portal on port 4000 after a successful build.
Default:
false -l--log-levelenum-
Minimum log level.
Values: trace, debug, information, warning, error, critical, none
Default:
information -c--config-sourceenum-
Override the configuration source: local, remote
Values: local, remote, embedded
--[no-]skip-private-repositories- Skip cloning private repositories
Build the portal from previously cloned repositories.
Clone all repositories listed in the codex configuration.
Index the built portal documentation into Elasticsearch.
Serve the built portal at http://localhost:4000.
Push the codex redirects mapping to CloudFront's KeyValueStore.