From 4edb7437f49c6c4dd15b98ebf06076aed98de0b1 Mon Sep 17 00:00:00 2001 From: Shouzhi Zhang <98078014+SZZhang0619@users.noreply.github.com> Date: Fri, 28 Jun 2024 15:54:27 +0800 Subject: [PATCH 1/5] docs: Add CLI - cap doctor command to docs --- docs/cli/commands/doctor.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 docs/cli/commands/doctor.md diff --git a/docs/cli/commands/doctor.md b/docs/cli/commands/doctor.md new file mode 100644 index 000000000..aaa5922b6 --- /dev/null +++ b/docs/cli/commands/doctor.md @@ -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 [] +``` + +Inputs: + +- `platform` (optional): `android`, `ios` From 47688bef9f63f9a4e27bca3ad3111edd5e945b32 Mon Sep 17 00:00:00 2001 From: Shouzhi Zhang <98078014+SZZhang0619@users.noreply.github.com> Date: Fri, 28 Jun 2024 16:11:38 +0800 Subject: [PATCH 2/5] fix: cli - doctor command links not working --- docs/cli/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/cli/index.md b/docs/cli/index.md index 04e75b794..54363c4ee 100644 --- a/docs/cli/index.md +++ b/docs/cli/index.md @@ -29,7 +29,7 @@ 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` From 2af0447e3fc99416be9b357609c81b3c7bc434b0 Mon Sep 17 00:00:00 2001 From: Shouzhi Zhang <98078014+SZZhang0619@users.noreply.github.com> Date: Mon, 1 Jul 2024 10:01:16 +0800 Subject: [PATCH 3/5] docs: Add CLI - cap migrate command to docs --- docs/cli/commands/migrate.md | 21 +++++++++++++++++++++ docs/cli/index.md | 2 +- 2 files changed, 22 insertions(+), 1 deletion(-) create mode 100644 docs/cli/commands/migrate.md diff --git a/docs/cli/commands/migrate.md b/docs/cli/commands/migrate.md new file mode 100644 index 000000000..465caa418 --- /dev/null +++ b/docs/cli/commands/migrate.md @@ -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] +``` + +Options: + +- `--noprompt>`: do not prompt for confirmation +- `--packagemanager `: The package manager to use for dependency installs (`npm`, `pnpm`, `yan`) +- `-h, --help`: display help for command diff --git a/docs/cli/index.md b/docs/cli/index.md index 54363c4ee..c3f61e335 100644 --- a/docs/cli/index.md +++ b/docs/cli/index.md @@ -32,7 +32,7 @@ View all available CLI commands and options. - [`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) From 5e15ca69249da86c3ca328931012a8759df669e5 Mon Sep 17 00:00:00 2001 From: Shouzhi Zhang <98078014+SZZhang0619@users.noreply.github.com> Date: Mon, 1 Jul 2024 10:12:26 +0800 Subject: [PATCH 4/5] Fix typo in CLI migrate.md file --- docs/cli/commands/migrate.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/cli/commands/migrate.md b/docs/cli/commands/migrate.md index 465caa418..43a793352 100644 --- a/docs/cli/commands/migrate.md +++ b/docs/cli/commands/migrate.md @@ -17,5 +17,5 @@ npx cap migrate [options] Options: - `--noprompt>`: do not prompt for confirmation -- `--packagemanager `: The package manager to use for dependency installs (`npm`, `pnpm`, `yan`) +- `--packagemanager `: The package manager to use for dependency installs (`npm`, `pnpm`, `yarn`) - `-h, --help`: display help for command From 1ae133a84331b8c2b50dae676f1aaa187e768d15 Mon Sep 17 00:00:00 2001 From: Shouzhi Zhang <98078014+SZZhang0619@users.noreply.github.com> Date: Mon, 1 Jul 2024 10:16:35 +0800 Subject: [PATCH 5/5] Fix unnecessary symbols in the CLI migrate.md file --- docs/cli/commands/migrate.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/cli/commands/migrate.md b/docs/cli/commands/migrate.md index 43a793352..fff281465 100644 --- a/docs/cli/commands/migrate.md +++ b/docs/cli/commands/migrate.md @@ -16,6 +16,6 @@ npx cap migrate [options] Options: -- `--noprompt>`: do not prompt for confirmation +- `--noprompt`: do not prompt for confirmation - `--packagemanager `: The package manager to use for dependency installs (`npm`, `pnpm`, `yarn`) - `-h, --help`: display help for command