@canva/cli 0.0.1-beta.9 → 1.0.0

package/README.md

@@ -13,7 +13,7 @@ CLI for creating and managing Canva Apps.
   - [Step 1: Install and log in](#step-1-install-and-log-in)
   - [Step 2: Create your app](#step-2-create-your-app)
   - [Step 3: Preview your app](#step-3-preview-your-app)
-- [Log out, auth token storage, and removal](#token-storage-and-removal)
+- [Log out, auth token storage, and removal](#log-out-auth-token-storage-and-removal)
 - [CLI reference](#cli-reference)
   - [Flags](#flags)
   - [Commands](#commands)
@@ -106,8 +106,18 @@ To preview your app:
    npm start
    ```
 
-3. In the Developer Portal, click **Preview** to open the Canva Editor preview.
-4. If this the first time previewing your app, click **Open** to preview your new app.
+3. The preview URL will be generated and opened automatically in your browser.
+4. If this is the first time previewing your app, click **Open** to preview your new app.
+
+### Step 4: Run a health check on your app
+
+After creating your app, you can diagnose potential issues using:
+
+```shell
+canva apps doctor
+```
+
+This checks for missing dependencies, outdated packages, and other issues.
 
 ## Log out, auth token storage, and removal
 
@@ -121,7 +131,7 @@ The auth token is located in your home directory under the `.canva-cli` folder.
 
 ### Removing the Token
 
-To delete the token, there are two options. However only the `canva logout` command revokes and deletes the token. If there's a copy of the token, it's possible to reconnect the Canva CLI to your account's apps using the token.
+To delete the token, there are two options. However, only the `canva logout` command revokes and deletes the token. If there's a copy of the token, it's possible to reconnect the Canva CLI to your account's apps using the token.
 
 #### Log out
 
@@ -134,7 +144,6 @@ To delete the token, there are two options. However only the `canva logout` comm
 #### Delete the file manually
 
 1. Locate the `credentials` file, which is stored in the following locations:
-
    - **macOS and Linux**: The token is stored in `~/.canva-cli/credentials`.
    - **Windows**: The token is stored in `%USERPROFILE%\.canva-cli\credentials`.
 
@@ -177,6 +186,14 @@ canva tip
 - **Aliases**:
   - `tips`: Also prints a random development tip.
 
+#### bug
+
+Raise an issue with the Canva CLI on GitHub.
+
+```shell
+canva bug
+```
+
 #### login
 
 Log in to the Canva CLI.
@@ -185,6 +202,9 @@ Log in to the Canva CLI.
 canva login
 ```
 
+- **Flags**:
+  - `--china`, `--cn`: Login to canva.cn, this will use canva.cn for all subsequent commands until you log out.
+
 #### logout
 
 Log out of the Canva CLI, and delete the saved auth token:
@@ -193,6 +213,10 @@ Log out of the Canva CLI, and delete the saved auth token:
 canva logout
 ```
 
+#### mcp
+
+Start the canva [MCP](https://modelcontextprotocol.io) server. This is usually called by your MCP client, such as Claude Desktop, Cursor, or other compatible tools. For more information on how to configure your MCP client to use the Canva MCP server, please see [MCP Server](https://www.canva.dev/docs/apps/mcp-server) in the developer documentation.
+
 #### apps
 
 Manage your Canva apps.
@@ -201,46 +225,122 @@ Manage your Canva apps.
 canva apps
 ```
 
-#### apps sub-commands
+##### create
+
+Create a new Canva app.
+
+```shell
+canva apps create "My New App" --template="hello_world" --distribution="public" --git --installDependencies
+```
+
+- **Arguments**:
+  - `--name`: Sets the app's name. Provide the name you want for the app.
+- **Flags**:
+  - `--template`: Specifies the starting template for the app.
+
+    Available templates:
+    - `"hello_world"`: Basic starting point.
+    - `"dam"`: Digital asset management integration.
+    - `"gen_ai"`: Generative AI app creation.
+
+  - `--distribution`: Sets the app's distribution type.
+
+    Available types:
+    - `"public"`: Available to all Canva users, subject to Canva review.
+    - `"private"`: Only available to your team, and requires team admin approval.
+
+      **Note**: You can't change the distribution setting after creating a new app with the `canva apps create` command.
+
+  - `--git`: Initializes a Git repository in the project directory.
+
+  - `--installDependencies`: Automatically installs necessary npm dependencies during the app creation process.
+
+  - `--optionalConfig`: Optional configuration files to be created in the project directory.
+
+    Available options:
+    - `"vscode"`: Adds a `.vscode` folder to the project directory.
+    - `"cursor"`: Adds a `.cursor` folder to the project directory.
+    - `"agents.md"`: Adds a `AGENTS.md` file to the project directory.
+    - `"claude"`: Adds a `CLAUDE.md` file to the project directory.
+
+  - `--offline`: Scaffold the app locally without also creating an app in the Developer Portal.
+  - `--yes`: Answer yes, or use the default, for all questions during app creation.
+
+##### list
+
+List all Canva apps.
+
+```shell
+canva apps list
+```
+
+- **Flags**:
+  - `--appId`: Specifies an App ID to select.
+  - `--all`, `-a`: Lists all apps at once without pagination.
+  - `--print`, `-p`: Prints the list of apps to the console without interactivity.
 
-- `create "app-name"`: Create a new Canva app.
+##### preview
 
-  ```shell
-  canva apps create "My New App" --template="hello_world" --distribution="public" --git --installDependencies
-  ```
+Preview your app.
 
-  - **Arguments**:
-    - `--name`: Sets the app's name. Provide the name you want for the app.
-  - **Flags**:
+```shell
+canva apps preview
+```
 
-    - `--template`: Specifies the starting template for the app.
+##### doctor
 
-      Available templates:
+Run diagnostics on your Canva App to identify and fix issues.
 
-      - `"hello_world"`: Basic starting point.
-      - `"dam"`: Digital asset management integration.
-      - `"gen_ai"`: Generative AI app creation.
+```shell
+canva apps doctor
+```
 
-    - `--distribution`: Sets the app's distribution type.
+- **Flags**:
+  - `--ci`: Run in CI mode (overrides all other flags: enables `--report`, `--silenceUpdates`, disables `--fix`, `--verbose`, skips environment checks).
+  - `--fix`: Automatically apply fixes for issues where possible.
+  - `--report`: Output check results without prompting for fixes.
+  - `--verbose`: Show detailed diagnostic output optimized for AI agent assistance.
+  - `--check`: Specify a specific check to run.
 
-      Available types:
+##### config
 
-      - `"public"`: Available to all Canva users, subject to Canva review.
-      - `"private"`: Only available to your team, and requires team admin approval.
+Manage your [App Configuration](https://www.canva.dev/docs/apps/app-configuration/).
 
-        **Note**: You can't change the distribution setting after creating a new app with the `canva apps create` command.
+```shell
+canva apps config
+```
+
+###### pull
 
-    - `--git`: Initializes a Git repository in the project directory.
+Fetch the [canva-app.json](https://www.canva.dev/docs/apps/app-configuration/canva-app-json/) config from the Developer Portal.
 
-    - `--installDependencies`: Automatically installs necessary npm dependencies during the app creation process.
+```shell
+canva apps config pull
+```
 
-    - `--offline`: Scaffold the app locally without also creating an app in the Developer Portal.
+- **Flags**:
+  - `--force`: Automatically pull config regardless of conflicts.
+  - `--strategy`: Choose the resolution option for config conflicts - local, remote or manual
 
-- `list`: List all Canva apps.
+###### push
 
-  ```shell
-  canva apps list
-  ```
+Submit the local [canva-app.json](https://www.canva.dev/docs/apps/app-configuration/canva-app-json/) to the Developer Portal.
+
+```shell
+canva apps config push
+```
+
+- **Flags**:
+  - `--force`: Automatically push config regardless of conflicts.
+  - `--strategy`: Choose the resolution option for config conflicts - local, remote or manual
+
+###### status
+
+Report on the status and validity of the [canva-app.json](https://www.canva.dev/docs/apps/app-configuration/canva-app-json/) config.
+
+```shell
+canva apps config status
+```
 
 #### logout
 
@@ -269,7 +369,7 @@ npm update -g @canva/cli@latest
 
 ## Contributions
 
-Currently the Canva CLI doesn't accept third-party contributions. Please submit any feature requests through the [Canva Developers Community](https://community.canva.dev/).
+Currently the Canva CLI doesn't accept third-party contributions. Please submit any feature requests through the [Canva Developers Community](https://community.canva.dev/) or raise an issue on [Github](https://github.com/canva-sdks/canva-cli/issues/new).
 
 ## License