Skip to content

Commit

Permalink
fix(core): update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jaysoo committed Aug 27, 2024
1 parent 0a94c12 commit c83e4bd
Showing 1 changed file with 74 additions and 0 deletions.
74 changes: 74 additions & 0 deletions docs/generated/cli/import.md
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit c83e4bd

Please sign in to comment.