Skip to content

docs: Add CLI - cap doctor & migrate command to docs #323

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions docs/cli/commands/doctor.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
title: CLI Command - cap doctor
description: Capacitor CLI - cap doctor
contributors:
- shouzhi
sidebar_label: doctor
---

# Capacitor CLI - cap doctor

Checks the current setup for common errors.

```bash
npx cap doctor [<platform>]
```

<strong>Inputs:</strong>

- `platform` (optional): `android`, `ios`
21 changes: 21 additions & 0 deletions docs/cli/commands/migrate.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
title: CLI Command - cap migrate
description: Capacitor CLI - cap migrate
contributors:
- shouzhi
sidebar_label: migrate
---

# Capacitor CLI - cap migrate

Migrate your current Capacitor app to the latest major version of Capacitor.

```bash
npx cap migrate [options]
```

<strong>Options:</strong>

- `--noprompt`: do not prompt for confirmation
- `--packagemanager <packageManager>`: The package manager to use for dependency installs (`npm`, `pnpm`, `yarn`)
- `-h, --help`: display help for command
4 changes: 2 additions & 2 deletions docs/cli/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,10 +29,10 @@ View all available CLI commands and options.
- [`add`](/cli/commands/add.md)
- [`build`](/cli/commands/build.md)
- [`copy`](/cli/commands/copy.md)
- `doctor`
- [`doctor`](/cli/commands/doctor.md)
- [`init`](/cli/commands/init.md)
- [`ls`](/cli/commands/ls.md)
- `migrate`
- [`migrate`](/cli/commands/migrate.md)
- [`open`](/cli/commands/open.md)
- [`run`](/cli/commands/run.md)
- [`sync`](/cli/commands/sync.md)
Expand Down