From c83e4bd2bc20530346412bfb517bcdcc9417761b Mon Sep 17 00:00:00 2001 From: Jack Hsu Date: Tue, 27 Aug 2024 16:39:17 -0400 Subject: [PATCH] fix(core): update docs --- docs/generated/cli/import.md | 74 ++++++++++++++++++++++++++++++++++++ 1 file changed, 74 insertions(+) create mode 100644 docs/generated/cli/import.md diff --git a/docs/generated/cli/import.md b/docs/generated/cli/import.md new file mode 100644 index 00000000000000..585015f640aef0 --- /dev/null +++ b/docs/generated/cli/import.md @@ -0,0 +1,74 @@ +--- +title: 'import - CLI command' +description: 'Import a project into the current workspace. Install git-filter-repo for faster imports (https://github.com/newren/git-filter-repo).' +--- + +# import + +Import a project into the current workspace. Install git-filter-repo for faster imports (https://github.com/newren/git-filter-repo). + +## Usage + +```shell +nx import [sourceRemoteUrl] [destination] +``` + +Install `nx` globally to invoke the command directly using `nx`, or use `npx nx`, `yarn nx`, or `pnpm nx`. + +## Options + +### depth + +Type: `number` + +The depth to clone the source repository (limit this for faster git clone) + +### destination + +Type: `string` + +The directory in the current workspace to import into + +### help + +Type: `boolean` + +Show help + +### interactive + +Type: `boolean` + +Default: `true` + +Interactive mode + +### ref + +Type: `string` + +The branch from the source repository to import + +### source + +Type: `string` + +The directory in the source repository to import from + +### sourceRemoteUrl + +Type: `string` + +The remote URL of the source to import + +### verbose + +Type: `boolean` + +Prints additional information about the commands (e.g., stack traces) + +### version + +Type: `boolean` + +Show version number