nx/docs/generated/cli/import.md
Isaac Mann 514ce17b8c
docs(core): import documentation (#27859)
Create an import project recipe
Creates the import command API reference
Adds the import command to the command landing page
2024-09-12 09:12:24 -04:00

31 lines
1.7 KiB
Markdown

---
title: 'import - CLI command'
description: 'Import code and git history from another repository into this repository.'
---
# import
Import code and git history from another repository into this repository.
## Usage
```shell
nx import [sourceRepository] [destinationDirectory]
```
Install `nx` globally to invoke the command directly using `nx`, or use `npx nx`, `yarn nx`, or `pnpm nx`.
## Options
| Option | Type | Description |
| ------------------------ | ------- | --------------------------------------------------------------------------- |
| `--depth` | number | The depth to clone the source repository (limit this for faster git clone). |
| `--destinationDirectory` | string | The directory in the current workspace to import into. |
| `--help` | boolean | Show help. |
| `--interactive` | boolean | Interactive mode. (Default: `true`) |
| `--ref` | string | The branch from the source repository to import. |
| `--sourceDirectory` | string | The directory in the source repository to import from. |
| `--sourceRepository` | string | The remote URL of the source to import. |
| `--verbose` | boolean | Prints additional information about the commands (e.g., stack traces). |
| `--version` | boolean | Show version number. |