@canva/create-app

CLI for setting up the boilerplate of a Canva App.

Table of contents

• Introduction
• Features
• Usage
• CLI reference
  • Arguments
  • Flags
  • Commands
• Next steps
• Limitations
• Contributing
• License

Introduction

@canva/create-app is a CLI for setting up the boilerplate of a Canva App. It's the best way to get an app up and running in a matter of seconds. To learn more about developing apps, see the official documentation.

Features

• Set up a dev environment with Canva's recommended tooling.
• Choose from various templates as a starting point for the app.
• Get a random development tip for working with the Apps SDk.

Usage

Run the following command:

npx @canva/create-app@latest

You'll be asked to complete a series of interactive prompts. A directory for the project will then be created in the current directory. The name of the directory will be derived from the name of the app — for example, "My Cool App" becomes my-cool-app.

To skip the interactive prompts, pass in the relevant arguments and flags:

npx @canva/create-app@latest "My Cool App" --template="hello_world" --git --installDependencies

CLI reference

Arguments

[name]

Sets the app's name.

npx @canva/create-app@latest "My Cool App"

Flags

--template

Specifies the template to use as a starting point for the app.

The available templates include:

• "hello_world": A basic template that provides a minimal starting point.
• "dam": A template for integrating with digital asset management applications.
• "gen_ai": A template for creating generative AI apps.

npx @canva/create-app@latest --template="hello_world"

--git

Initializes a Git repository in the project directory.

npx @canva/create-app@latest --git
# npx @canva/create-app@latest --git=false

--installDependencies

Automatically installs the project's dependencies with npm.

npx @canva/create-app@latest --installDependencies
# npx @canva/create-app@latest --installDependencies=false

--lite

Activates a simplified CLI version to enhance accessibility.

npx @canva/create-app@latest --lite

--version

Displays the CLI’s current version.

npx @canva/create-app@latest --version

--help

Provides usage information about the CLI.

npx @canva/create-app@latest --help

Commands

tip

Displays a random tip for developing apps with the Apps SDK. This command is not compatible with the flags.

npx @canva/create-app@latest tip

Next steps

• Set up an app via the Developer Portal
• Preview the app in the Canva editor
• Use the Apps SDK to integrate with Canva

Limitations

• For the time being, the CLI does not integrate with Canva's Developer Portal. You still have to manually create and otherwise configure the app via the Developer Portal.

Contributing

We're actively developing this package but are not currently accepting third-party contributions. If you'd like to request any changes or additions to the package, submit a feature request via the Canva Developers Community.

License

See the LICENSE.md file.