Skip to content

Docgen Example

Terminal window
one <command> [options...]
OptionTypeDescription
--dry-runbooleanRun without actually making modifications or destructive operations
--verbosity, -vcount, default: 2Set the verbosity of the script output. Increase verbosity with -vvv, -vvvv, or -vvvvv. Reduce verbosity with -v or --quiet
--versionbooleanShow the oneRepo CLI version.
Advanced options
OptionTypeDescription
--help, -hbooleanShow this help screen
--quiet, -qbooleanSilence all output from the logger. Effectively sets verbosity to 0.
--show-advancedbooleanPair with --help to show advanced options.
--skip-engine-checkbooleanSkip the engines check, which ensures the current Node.js version is within the expected range.

Build public Workspaces using esbuild.

Terminal window
one build [options...]
OptionTypeDescription
--affectedbooleanSelect all affected Workspaces. If no other inputs are chosen, this will default to true.
--all, -abooleanRun across all Workspaces
--stagedbooleanUse files on the git stage to calculate affected files or Workspaces. When unset or --no-staged, changes will be calculated from the entire branch, since its fork point.
--workspaces, -warrayList of Workspace names to run against
Advanced options
OptionTypeDescription
--from-refstringGit ref to start looking for affected files or Workspaces
--through-refstringGit ref to start looking for affected files or Workspaces

Build all Workspaces.

Terminal window
one build

Build the graph Workspace only.

Terminal window
one build -w graph

Build the graph, cli, and logger Workspaces.

Terminal window
one build -w graph cli logger

Aliases: one changes, one changesets

Manage changes and changesets for publishable Workspaces.

Terminal window
one change <command>

Aliases: one change

Add changesets for modified Workspaces.

Terminal window
one change add [options...]

This command will prompt for appropriate Workspace(s), prompt for the release type, and request a descriptive change entry. Once all information has been entered, a change entry file will be created in the appropriate Workspace(s). Be sure to commit these files – they will be used later when you are ready to version and publish Workspaces to the registry for use outside of the Monorepo.

OptionTypeDescription
--addboolean, default: trueAdd the modified package.json files to the git stage for committing.
--affectedbooleanSelect all affected Workspaces. If no other inputs are chosen, this will default to true.
--all, -abooleanRun across all Workspaces
--type"major", "minor", "patch"Provide a semantic version bump type. If not given, a prompt will guide you through selecting the appropriate type.
--workspaces, -warrayList of Workspace names to run against
Advanced options
OptionTypeDescription
--filenames"hash", "human", default: "human"Filename generation strategy for change files. If 'human', ensure you have the human-id package installed.
--from-refstringGit ref to start looking for affected files or Workspaces
--prompts"guided", "semver", default: "guided"Change the prompt question & answer style when adding change entries.
--stagedbooleanUse files on the git stage to calculate affected files or Workspaces. When unset or --no-staged, changes will be calculated from the entire branch, since its fork point.
--through-refstringGit ref to start looking for affected files or Workspaces

Migrate from Changesets to oneRepo changes.

Terminal window
one change migrate
Advanced options
OptionTypeDescription
--filenames"hash", "human", default: "human"Filename generation strategy for change files. If 'human', ensure you have the human-id package installed.

Aliases: one change release

Publish all Workspaces with versions not available in the registry.

Terminal window
one change publish [options...]

This command is safe to run any time. By default, only Workspaces that have previously gone through the one change version process will end up being published. Use --all for all Workspaces or --workspaces <workspace-name> to specify individual Workspaces to try publishing.

For each Workspace, the registry will be queried first to ensure the current version in the Workspace does not yet exist in the registry. If a version does exist, the Workspace will be skipped.

OptionTypeDescription
--all, -abooleanRun across all Workspaces
--otpbooleanSet to true if your publishes require an OTP for NPM.
--skip-authbooleanSkip auth checks. This may be necessary for some internal registries using PATs or tokens.
--workspaces, -warrayList of Workspace names to run against
Advanced options
OptionTypeDescription
--affectedbooleanSelect all affected Workspaces. If no other inputs are chosen, this will default to true.
--allow-dirtybooleanBypass checks to ensure no there are no un-committed changes.
--from-refstringGit ref to start looking for affected files or Workspaces
--stagedbooleanUse files on the git stage to calculate affected files or Workspaces. When unset or --no-staged, changes will be calculated from the entire branch, since its fork point.
--through-refstringGit ref to start looking for affected files or Workspaces

Publish the api Workspace and its dependencies, if necessary.

Terminal window
one change publish -w api

Attempt to publish all non-private Workspaces.

Terminal window
one change publish --all

Preview the next versions and changelogs for Workspaces.

Terminal window
one change show
OptionTypeDescription
--all, -abooleanRun across all Workspaces
--format"json", "plain", default: "plain"Choose how the results will be returned.
--workspaces, -warrayList of Workspace names to run against

Aliases: one change snap

Publish a snapshot pre-release.

Terminal window
one change snapshot

Periodically you may want to publish a snapshot release – something that needs testing from the registry, but should not update the current version nor be made widely available. For these cases, use --snapshot and versions will be published in the format 0.0.0-{tag}-{hash}, where {hash} is a short version of the current git sha. By appending a prerelease to version 0.0.0, discoverability is greatly reduced.

OptionTypeDescription
--all, -abooleanRun across all Workspaces
--allow-dirtybooleanBypass checks to ensure no there are no un-committed changes.
--otpbooleanPrompt for one-time password before publishing to the registry
--resetboolean, default: trueReset package.json changes before exiting. Use --no-reset to disable.
--tagstring, default: "prerelease"Distribution tag to apply when publishing the pre-release.
--workspaces, -warrayList of Workspace names to run against

Aliases: one change required

Ensure there are change entries for every modified public Workspace.

Terminal window
one change verify

Add this to your pre-commit or pre-merge task lifecycles to ensure that changes to public & publishabled Workspaces are always accompanied with change entries.


Update version numbers for publishable Workspaces

Terminal window
one change version
OptionTypeDescription
--all, -abooleanRun across all Workspaces
--allow-dirtybooleanBypass checks to ensure no there are no un-committed changes.
--prerelease, --pre, --pre-releasestringCreate a pre-release using the specified identifier.
--workspaces, -warrayList of Workspace names to run against

Create a prerelease for the next version the form of 1.2.3-alpha.0.

Terminal window
one change version --prerelease=alpha

Aliases: one owners

Manage codeowners

Terminal window
one codeowners <command>

Show the code owners for files and Workspaces.

Terminal window
one codeowners show [options]
OptionTypeDescription
--affectedbooleanSelect all affected Workspaces. If no other inputs are chosen, this will default to true.
--all, -abooleanRun across all Workspaces
--files, -farrayDetermine Workspaces from specific files
--format"plain", "json", default: "plain"Choose how the results will be returned.
--listbooleanJust list the owners without the files
--stagedbooleanUse files on the git stage to calculate affected files or Workspaces. When unset or --no-staged, changes will be calculated from the entire branch, since its fork point.
--workspaces, -warrayList of Workspace names to run against
Advanced options
OptionTypeDescriptionRequired
--from-refstringGit ref to start looking for affected files or Workspaces
--provider"github", "gitlab", "gitea", "bitbucket"Codeowner provider determines where the CODEOWNERS file(s) will be written.
--through-refstringGit ref to start looking for affected files or Workspaces

Show the codeowners for currently modified files.

Terminal window
one codeowners show

List the unique set of codeowners given an input workspace-name.

Terminal window
one codeowners show --list -w <workspace-name>

Sync code owners from Workspace configurations to the repository’s CODEOWNERS file.

Terminal window
one codeowners sync

This command will sync each Workspace’s codeowners to the repository’s configured vcs.provider compatible code owners file.

  • github: .github/CODEOWNERS
  • gitlab: .gitlab/CODEOWNERS
  • gitea: .gitea/CODEOWNERS
  • bitbucket: CODEOWNERS
OptionTypeDescription
--addbooleanAdd the updated CODEOWNERS file to the git stage.
Advanced options
OptionTypeDescriptionRequired
--provider"github", "gitlab", "gitea", "bitbucket"Codeowner provider determines where the CODEOWNERS file(s) will be written.

Verify the CODEOWNERS file is up to date and unmodified.

Terminal window
one codeowners verify
Advanced options
OptionTypeDescriptionRequired
--provider"github", "gitlab", "gitea", "bitbucket"Codeowner provider determines where the CODEOWNERS file(s) will be written.

Aliases: one dependency, one deps, one dep

Safely manage Workspace dependencies across your repository.

Terminal window
one dependencies <command> [options...]

Add dependencies to Workspaces.

Terminal window
one dependencies add -w <workspace-names...> --dev [devDependencies...] --prod [prodDependencies...] [options...]

If a version is not provided with the command-line input, this command will look for currently installed versions of the requested dependencies throughout all Workspaces within the Workspace Graph. If only one version is found, it will be used, regardless of the --mode provided.

If multiple versions of the requested dependencies are found in the Workspace Graph, a prompt will be presented to choose the appropriate version.

Otherwise, the latest version will be requested from the registry.

OptionTypeDescription
--all, -abooleanRun across all Workspaces
--dedupeboolean, default: trueDeduplicate dependencies across the repository after install is complete.
--dev, -darrayAdd dependencies for development purposes only.
--mode"strict", "loose", "off", default: "loose"Version selection mode. Use strict to use strict version numbers, loose to use caret (^) ranges, and off for nothing specific.
--prod, -parrayAdd dependencies for production purposes.
--workspaces, -warrayOne or more Workspaces to add dependencies into

Install the latest version of normalizr from the registry, using a strict version number.

Terminal window
one dependencies add -w my-workspace -d normalizr --mode strict

Install the latest version of normalizr from the registry, using a caret (^) version number range, enabling newer minor and patch releases to satisfy the dependency in the future.

Terminal window
one dependencies add -w my-workspace -d normalizr --mode loose

Install react as a production dependency and babel-core as a development dependency in both workspace-a and workspace-b.

Terminal window
one dependencies add -w workspace-a workspace-b -d babel-core -p react

Remove dependencies from Workspaces.

Terminal window
one dependencies remove -w [workspaces...] -d [dependencies...] [options...]
OptionTypeDescriptionRequired
--all, -abooleanRun across all Workspaces
--dedupeboolean, default: trueDeduplicate dependencies across the repository after install is complete.
--dependencies, -darrayDependency names that should be removed.
--workspaces, -warrayList of Workspace names to run against

Verify dependencies across Workspaces.

Terminal window
one dependencies verify [options...]

Dependencies across Workspaces can be validated using one of the various modes:

  • off: No validation will occur. Everything goes.
  • loose: Reused third-party dependencies will be required to have semantic version overlap across unique branches of the Graph.
  • strict: Versions of all dependencies across each discrete Workspace dependency tree must be strictly equal.
OptionTypeDescription
--all, -abooleanRun across all Workspaces
--mode"strict", "loose", "off", default: "loose"Version selection mode. Use strict to use exact version matches, loose to accept within defined ranges (^ or ~ range), and off for no verification.
--workspaces, -warrayList of Workspace names to run against

Generate documentation for the oneRepo cli.

Terminal window
one docgen [options...]

Help documentation should always be easy to find. This command will help automate the creation of docs for this command-line interface. If you are reading this somewhere that is not your terminal, there is a very good chance that this command was already run for you!

Add this command to your one Repo tasks on pre-commit to ensure that your documentation is always up-to-date.

OptionTypeDescription
--addbooleanAdd the output file to the git stage
--format"markdown", "json", default: "markdown"Output format for documentation
--heading-levelnumberHeading level to start at for Markdown output
--out-filestring, default: "./docs/src/content/docs/plugins/docgen/example.mdx"File to write output to. If not provided, stdout will be used
--out-workspacestring, default: "root"Workspace name to write the —out-file to
--safe-writeboolean, default: trueWrite documentation to a portion of the file with start and end sentinels.
Advanced options
OptionTypeDescription
--commandstringStart at the given command, skip the root and any others
--use-defaultsbooleanUse the oneRepo default configuration. Helpful for generating default documentation.

Aliases: one lint

Run eslint across files and Workspaces.

Terminal window
one eslint [options...]
OptionTypeDescription
--addbooleanAdd modified files after write to the git stage.
--affectedbooleanSelect all affected Workspaces. If no other inputs are chosen, this will default to true.
--all, -abooleanRun across all Workspaces
--cacheboolean, default: trueUse cache if available
--extensionsarray, default: ["ts","tsx","js","jsx","cjs","mjs","astro"]Make ESLint check files given these extensions.
--files, -farrayDetermine Workspaces from specific files
--fixboolean, default: trueApply auto-fixes if possible
--prettyboolean, default: trueControl ESLint’s --color flag.
--quietbooleanReport errors only
--stagedbooleanUse files on the git stage to calculate affected files or Workspaces. When unset or --no-staged, changes will be calculated from the entire branch, since its fork point.
--workspaces, -warrayList of Workspace names to run against
Advanced options
OptionTypeDescription
--from-refstringGit ref to start looking for affected files or Workspaces
--github-annotateboolean, default: trueAnnotate files in GitHub with errors when failing lint checks in GitHub Actions
--through-refstringGit ref to start looking for affected files or Workspaces

Aliases: one gen

Generate files, folders, and Workspaces from templates.

Terminal window
one generate [options...]

To create new templates add a new folder to config/templates and create a .onegen.cjs configuration file. Follow the instructions online for more: https://onerepo.tools/core/generate/

OptionTypeDescription
--type, -tstringTemplate type to generate. If not provided, a list will be provided to choose from.
Advanced options
OptionTypeDescriptionRequired
--template-dir, --templates-dirstring, default: "config/templates"Path to the templates

Run core Graph commands

Terminal window
one graph <command>

Show this repository’s Workspace Graph using an online visualizer or output Graph representations to various formats.

Terminal window
one graph show [options...]

This command can generate representations of your Workspace Graph for use in debugging, verifying, and documentation. By default, a URL will be given to visualize your Graph online.

Pass --open to auto-open your default browser with the URL or use one of the --format options to print out various other representations.

OptionTypeDescription
--affectedbooleanSelect all affected Workspaces. If no other inputs are chosen, this will default to true.
--all, -abooleanRun across all Workspaces
--format, -f"mermaid", "plain", "json"Output format for inspecting the Workspace Graph.
--openbooleanAuto-open the browser for the online visualizer.
--stagedbooleanUse files on the git stage to calculate affected files or Workspaces. When unset or --no-staged, changes will be calculated from the entire branch, since its fork point.
--workspaces, -warrayList of Workspace names to run against
Advanced options
OptionTypeDescription
--from-refstringGit ref to start looking for affected files or Workspaces
--through-refstringGit ref to start looking for affected files or Workspaces
--urlstring, default: "https://onerepo.tools/visualize/"Override the URL used to visualize the Graph. The Graph data will be attached the the g query parameter as a JSON string of the DAG, compressed using zLib deflate.

Print a URL to the online visualizer for the current affected Workspace Graph.

Terminal window
one graph show

Open the online visualizer for your full Workspace Graph.

Terminal window
one graph show --all --open

Generate a Mermaid graph to a file, isolating just the given <workspaces...> and those that are dependent on it.

Terminal window
one graph show --format=mermaid -w <workspaces...> > ./out.mermaid

Verify the integrity of the repo’s dependency Graph and files in each Workspace.

Terminal window
one graph verify

This command will first validate dependencies across Workspace Graph trees using the given --mode as well as Workspace configuration file integrity using the repo’s defined JSON schema validators.

Dependencies across Workspaces can be validated using one of the various modes:

  • off: No validation will occur. Everything goes.
  • loose: Reused third-party dependencies will be required to have semantic version overlap across unique branches of the Graph.
  • strict: Versions of all dependencies across each discrete Workspace dependency tree must be strictly equal.
OptionTypeDescription
--mode"strict", "loose", "off", default: "loose"Dependency overlap validation method.
Advanced options
OptionTypeDescription
--custom-schemastring, default: "config/graph-schema.ts"Path to a custom JSON schema definition

Manage git repository hooks

Terminal window
one hooks <command>

Create git hooks

Terminal window
one hooks create
OptionTypeDescription
--addboolean, default: trueAdd the hooks to the git stage for committing.
--hook"applypatch-msg", "pre-applypatch", "post-applypatch", "pre-commit", "pre-merge-commit", "prepare-commit-msg", "commit-msg", "post-commit", "pre-rebase", "post-checkout", "post-merge", "pre-receive", "update", "post-receive", "post-update", "pre-auto-gc", "post-rewrite", "pre-push", "proc-receive", "push-to-checkout", default: ["pre-commit","post-checkout","post-merge","post-rewrite"]The git hook to create. Omit this option to auto-create recommended hooks.
--overwritebooleanOverwrite existing hooks
Advanced options
OptionTypeDescriptionRequired
--hooks-pathstringTracked path to use for git hooks. This option is defaulted via the oneRepo root config.

Aliases: one hooks sync

Initialize and sync git hook settings for this repository.

Terminal window
one hooks init
Advanced options
OptionTypeDescriptionRequired
--hooks-pathstringTracked path to use for git hooks.

Install the oneRepo CLI into your environment.

Terminal window
one install [options...]
OptionTypeDescription
--forcebooleanForce installation regardless of pre-existing command.
--locationstringInstall location for the binary. Default location is chosen as default option for usr/bin dependent on the OS type.
--versionstring, default: "1.1.1"Version of oneRepo to install. Defaults to the current version.

Aliases: one test

Run tests using Jest.

Terminal window
one jest [options...] -- [passthrough]
one jest [options...]

This test commad will automatically attempt to run only the test files related to the changes in your working state. If you have un-committed changes, only those related to files that are in a modified state will be run. If there are no un-committed changes, test files related to those modified since your git merge-base will be run. By passing specific filepaths as extra passthrough arguments an argument separator (two dasshes --), you can further restrict the tests to those files and paths.

Additionally, any other Jest CLI options can be passed as passthrough arguments as well after an argument separator (two dashes --)

OptionTypeDescription
--affectedbooleanSelect all affected Workspaces. If no other inputs are chosen, this will default to true.
--all, -abooleanRun across all Workspaces
--inspectbooleanBreak for the the Node inspector to debug tests.
--prettyboolean, default: trueControl Jest’s --colors flag.
--stagedbooleanUse files on the git stage to calculate affected files or Workspaces. When unset or --no-staged, changes will be calculated from the entire branch, since its fork point.
--watchbooleanShortcut for jest --watch mode.
--workspaces, -warrayList of Workspace names to run against
Advanced options
OptionTypeDescription
--configstring, default: "./jest.config.js"Path to the jest.config file, relative to the repo root.
--from-refstringGit ref to start looking for affected files or Workspaces
--passWithNoTestsboolean, default: trueAllows the test suite to pass when no files are found. See plugin configuration to disable.
--through-refstringGit ref to start looking for affected files or Workspaces

Run only tests related to modified files.

Terminal window
one jest ,test

Runs jest in —watch mode against the currently affected files.

Terminal window
one jest ,test --watch

Run Jest in watch mode against a particular file.

Terminal window
one jest ,test --watch -- path/to/test.ts

Pass any other Jest CLI options after the argument separator.

Terminal window
one jest ,test -- --runInBand --detectOpenHandles

Aliases: one format

Format files with prettier

Terminal window
one prettier [options...]
OptionTypeDescription
--addbooleanAdd modified files after write
--affectedbooleanSelect all affected Workspaces. If no other inputs are chosen, this will default to true.
--all, -abooleanRun across all Workspaces
--checkbooleanCheck for changes.
--files, -farrayDetermine Workspaces from specific files
--stagedbooleanUse files on the git stage to calculate affected files or Workspaces. When unset or --no-staged, changes will be calculated from the entire branch, since its fork point.
--workspaces, -warrayList of Workspace names to run against
Advanced options
OptionTypeDescription
--cacheboolean, default: trueUse Prettier’s built-in cache to determin whether files need formatting or not.
--from-refstringGit ref to start looking for affected files or Workspaces
--github-annotateboolean, default: trueAnnotate files in GitHub with errors when failing format checks in GitHub Actions.
--through-refstringGit ref to start looking for affected files or Workspaces

Run tasks against repo-defined lifecycles. This command will limit the tasks across the affected Workspace set based on the current state of the repository.

Terminal window
one tasks --lifecycle=<lifecycle> [options...]

You can fine-tune the determination of affected Workspaces by providing a --from-ref and/or through-ref. For more information, get help with --help --show-advanced.

OptionTypeDescriptionRequired
--affectedbooleanSelect all affected Workspaces. If no other inputs are chosen, this will default to true.
--all, -abooleanRun across all Workspaces
--ignore-unstagedbooleanForce staged-changes mode on or off. If true, task determination and runners will ignore unstaged changes.
--lifecycle, -c"pre-commit", "post-commit", "post-checkout", "pre-merge", "post-merge", "build", "pre-deploy", "pre-publish", "post-publish"Task lifecycle to run. All tasks for the given lifecycle will be run as merged parallel tasks, followed by the merged set of serial tasks.
--listbooleanList found tasks. Implies dry run and will not actually run any tasks.
--shardstringShard the lifecycle across multiple instances. Format as <shard-number>/<total-shards>
--stagedbooleanBackup unstaged files and use only those on the git stage to calculate affected files or Workspaces. Will re-apply the unstaged files upon exit.
--workspaces, -warrayList of Workspace names to run against
Advanced options
OptionTypeDescription
--from-refstringGit ref to start looking for affected files or Workspaces
--ignorearray, default: ["**/README.md","**/CHANGELOG.md"]List of filepath strings or globs to ignore when matching tasks to files.
--through-refstringGit ref to start looking for affected files or Workspaces

Shard all tasks for the pre-merge lifecycle into 5 groups and runs the first shard.

Terminal window
one tasks --lifecycle=pre-merge --shard=1/5

Shard all tasks for the pre-merge lifecycle into 5 groups and runs the third shard.

Terminal window
one tasks --lifecycle=pre-merge --shard=3/5

Aliases: one typescript, one typecheck

Sync TS project references

Terminal window
one tsc [options...]

Checks for the existence of tsconfig.json file and batches running tsc --noEmit in each Workspace.

OptionTypeDescription
--affectedbooleanSelect all affected Workspaces. If no other inputs are chosen, this will default to true.
--all, -abooleanRun across all Workspaces
--prettyboolean, default: trueControl TypeScript’s --pretty flag.
--stagedbooleanUse files on the git stage to calculate affected files or Workspaces. When unset or --no-staged, changes will be calculated from the entire branch, since its fork point.
--workspaces, -warrayList of Workspace names to run against
Advanced options
OptionTypeDescription
--from-refstringGit ref to start looking for affected files or Workspaces
--through-refstringGit ref to start looking for affected files or Workspaces
--tsconfigstring, default: "tsconfig.json"The filename of the tsconfig to find in each Workspace.
--use-project-references, --project-references, --project-refsboolean, default: trueAutomatically sync and use typescript project references

Aliases: one test

Run unit tests using Vitest

Terminal window
one vitest ,test [options...] -- [passthrough]
one vitest [options...]

This test commad will automatically attempt to run only the test files related to the changes in your git branch. By passing specific filepaths as extra passthrough arguments after two dashes (--), you can further restrict the tests to those specific files only.

Additionally, any other Vitest CLI options can be used as passthrough arguments as well after an argument separator (two dashes --).

OptionTypeDescription
--affectedbooleanSelect all affected Workspaces. If no other inputs are chosen, this will default to true.
--all, -abooleanRun across all Workspaces
--inspectbooleanBreak for the the Node inspector to debug tests.
--stagedbooleanUse files on the git stage to calculate affected files or Workspaces. When unset or --no-staged, changes will be calculated from the entire branch, since its fork point.
--watchbooleanShortcut for vitest --watch mode.
--workspaces, -warrayList of Workspace names to run against
Advanced options
OptionTypeDescription
--configstring, default: "./vitest.config.ts"Path to the vitest.config file, relative to the repo root.
--from-refstringGit ref to start looking for affected files or Workspaces
--through-refstringGit ref to start looking for affected files or Workspaces

Run only tests related to modified files.

Terminal window
one vitest ,test

Run vitest in —watch mode.

Terminal window
one vitest ,test --watch

Run vitest in watch mode with a particular file.

Terminal window
one vitest ,test --watch -- path/to/test.ts

Run all tests in a given Workspace.

Terminal window
one vitest ,test -w <workspaces...>

Aliases: one ws

Run commands within individual Workspaces.

Terminal window
one workspace <workspace-name> <commands...> [options...] -- [passthrough...]

This enables running both custom commands as defined via the commands.directory configuration option within each Workspace as well as commands.passthrough aliases.

Arguments for passthrough commands meant for the underlying command must be sent after --.

PositionalTypeDescription
commandstringCommand to run.
workspace-namestringThe name or alias of a Workspace.

Aliases: one workspace @onerepo/docs

Runs commands in the “@onerepo/docs” Workspace.


Run Astro directly.


Build the documentation site for production.


Aliases: one workspace docs pull-changelogs

Update changelogs from source files

OptionTypeDescription
--addbooleanAdd files to the git index
--affectedbooleanSelect all affected Workspaces. If no other inputs are chosen, this will default to true.
--all, -abooleanRun across all Workspaces
--files, -farrayDetermine Workspaces from specific files
--stagedbooleanUse files on the git stage to calculate affected files or Workspaces. When unset or --no-staged, changes will be calculated from the entire branch, since its fork point.
--workspaces, -warrayList of Workspace names to run against
Advanced options
OptionTypeDescription
--from-refstringGit ref to start looking for affected files or Workspaces
--through-refstringGit ref to start looking for affected files or Workspaces

Check Astro pages for errors.


one workspace docs collect-content
Section titled one workspace docs collect-content

Generate docs for the oneRepo monorepo

OptionTypeDescription
--addbooleanAdd files to the git index
--affectedbooleanSelect all affected Workspaces. If no other inputs are chosen, this will default to true.
--all, -abooleanRun across all Workspaces
--files, -farrayDetermine Workspaces from specific files
--stagedbooleanUse files on the git stage to calculate affected files or Workspaces. When unset or --no-staged, changes will be calculated from the entire branch, since its fork point.
--workspaces, -warrayList of Workspace names to run against
Advanced options
OptionTypeDescription
--from-refstringGit ref to start looking for affected files or Workspaces
--through-refstringGit ref to start looking for affected files or Workspaces

Start the Astro dev server.


Generate typedoc markdown files for the toolchain.

Terminal window
one workspace docs typedoc
OptionTypeDescription
--addbooleanAdd files to the git index

Aliases: one workspace @onerepo/github-action

Runs commands in the “@onerepo/github-action” Workspace.


one workspace github-action build
Section titled one workspace github-action build

Build public Workspaces using esbuild.

Terminal window
one workspace github-action build [options...]
OptionTypeDescription
--affectedbooleanSelect all affected Workspaces. If no other inputs are chosen, this will default to true.
--all, -abooleanRun across all Workspaces
--stagedbooleanUse files on the git stage to calculate affected files or Workspaces. When unset or --no-staged, changes will be calculated from the entire branch, since its fork point.
--workspaces, -warrayList of Workspace names to run against
Advanced options
OptionTypeDescription
--from-refstringGit ref to start looking for affected files or Workspaces
--through-refstringGit ref to start looking for affected files or Workspaces

Build all Workspaces.

Terminal window
one workspace github-action build

Build the graph Workspace only.

Terminal window
one workspace github-action build -w graph

Build the graph, cli, and logger Workspaces.

Terminal window
one workspace github-action build -w graph cli logger

Aliases: one lint

Run eslint across files and workspaces

Terminal window
one eslint [options...]
OptionTypeDescription
--addbooleanAdd modified files after write to the git stage.
--affectedbooleanSelect all affected Workspaces. If no other inputs are chosen, this will default to true.
--all, -abooleanRun across all workspaces
--cacheboolean, default: trueUse cache if available
--extensionsarray, default: ["ts","tsx","js","jsx","cjs","mjs","astro"]
--files, -farrayDetermine Workspaces from specific files
--fixboolean, default: trueApply auto-fixes if possible
--prettyboolean, default: trueControl ESLint’s --color flag.
--quietbooleanReport errors only
--stagedbooleanUse files on the git stage to calculate affected files or Workspaces. When unset or --no-staged, changes will be calculated from the entire branch, since its fork point.
--workspaces, -warrayList of Workspace names to run against
Advanced options
OptionTypeDescription
--from-refstringGit ref to start looking for affected files or workspaces
--github-annotateboolean, default: trueAnnotate files in GitHub with errors when failing lint checks in GitHub Actions
--show-advancedbooleanPair with --help to show advanced options.
--through-refstringGit ref to start looking for affected files or workspaces