@canva/cli 0.0.1-beta.1

package/LICENSE.md

@@ -0,0 +1,48 @@
+# A message from Canva
+
+By making these software components available to you, our goal is to give you
+the right to use the components to build your apps for Canva's ecosystem. See
+below for the specific licence terms that apply to your use.
+
+# Licence
+
+Canva Pty Ltd (ACN 158 929 938) ("Canva") owns the copyright in the software and
+associated documentation files to which this Licence relates (each a "Software
+Component"). Canva reserves all of its rights.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+the Software Components ("You"), to use the Software Components, but strictly
+subject to the following restrictions and conditions:
+
+1. You must only use the Software Components and any Derivative on the Canva
+   Platform.
+
+2. You must only use the Software Components and any Derivative for the purpose
+   of building or updating Permitted Apps, and for no other purpose.
+
+3. You must include a copy of this Licence in all copies of any Software
+   Component and Derivative.
+
+4. To the fullest extent permitted by law, the Software Components are provided
+   "as is", without warranty of any kind, express or implied, including but not
+   limited to the warranties of merchantability, fitness for a particular
+   purpose and non-infringement. To the fullest extent permitted by law, in no
+   event shall the authors or copyright holders be liable for any claim,
+   damages or other liability, whether in an action of contract, tort or
+   otherwise, arising from, out of or in connection with the Software Components
+   or any Derivative, or the use of or other dealings in the Software Components
+   or any Derivative.
+
+5. In this Licence:
+
+   (a) "Canva Platform" means the visual communications platform owned and
+   operated by Canva that is made available on Canva.com (as well as any
+   sub-domains and international versions) and via mobile applications, desktop
+   applications, and in other forms provided or made available by Canva;
+
+   (b) "Derivative" means any software, document or other material that: (i)
+   contains any Software Component; and/or (ii) comprises or contains a
+   derivative, adaptation or substantial part of any Software Component; and
+
+   (c) "Permitted App" means a software application that is solely offered to
+   end-users on the Canva Platform.

package/README.md

@@ -0,0 +1,206 @@
+# @canva/cli
+
+CLI for creating and managing Canva Apps.
+
+![](https://img.shields.io/badge/React-20232A?style=for-the-badge&logo=react&logoColor=61DAFB) ![](https://img.shields.io/badge/TypeScript-007ACC?style=for-the-badge&logo=typescript&logoColor=white)
+
+## Table of contents
+
+- [Introduction](#introduction)
+- [Features](#features)
+- [Usage](#usage)
+- [CLI reference](#cli-reference)
+  - [Flags](#flags)
+  - [Commands](#commands)
+- [Next steps](#next-steps)
+- [Limitations](#limitations)
+- [Updating](#updating)
+- [Contributing](#contributing)
+- [License](#license)
+
+## Introduction
+
+`@canva/cli` is a command line tool designed for creating and managing Canva Apps. To learn more about app development, visit [the official documentation](https://www.canva.dev/docs/apps).
+
+## Features
+
+- Log in to your Canva account.
+- Create and manage apps directly from the command line.
+- Utilize Canva's recommended development tools and templates.
+
+## Prerequisites
+
+Before using the CLI, ensure that you have the following installed:
+
+- Node.js `v18.20.4` or `v20.17.0`
+- npm `v9` or `v10`
+
+## Usage
+
+To start using the CLI, first install it globally:
+
+```bash
+npm install -g @canva/cli
+```
+
+After installation, you can use the CLI by running:
+
+```bash
+canva <command>
+```
+
+## CLI Reference
+
+### Flags
+
+Top-level flags applicable across commands:
+
+- `--help`: Display help information about commands and flags.
+- `--lite`: Enable a simplified CLI interface for enhanced accessibility.
+- `--version`: Show the version number of the CLI.
+
+### Commands
+
+#### welcome
+
+Display the welcome page and general information.
+
+- **Usage**:
+
+  ```bash
+  canva welcome
+  ```
+
+#### tip
+
+Get a random development tip for working with the Apps SDK.
+
+- **Usage**:
+
+  ```bash
+  canva tip
+  ```
+
+- **Aliases**: `tips`
+
+#### login
+
+Log in to the Canva CLI.
+
+- **Usage**:
+
+  ```bash
+  canva login
+  ```
+
+#### apps
+
+Manage your Canva apps.
+
+- **Usage**:
+
+  ```bash
+  canva apps
+  ```
+
+- **Sub-Commands**:
+
+  - `create [name]`: Create a new Canva app.
+
+    - **Usage**:
+
+      ```bash
+      canva apps create "My New App" --template="hello_world" --distribution="public" --git --installDependencies
+      ```
+
+    - **Arguments**:
+      - `[name]`: Sets the app's name. Provide the desired name of the app when using this command.
+    - **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.
+
+        Options:
+
+        - `"public"`: Available to all Canva users, subject to Canva review.
+        - `"private"`: Only available to your team, requires team admin approval.
+
+        > [!Note]
+        > This setting cannot be changed after the app is created.
+
+      - `--git`: Initializes a Git repository in the project directory.
+
+      - `--installDependencies`: Automatically installs necessary npm dependencies.
+
+  - `list`: List all Canva apps.
+
+    - **Usage**:
+
+      ```bash
+      canva apps list
+      ```
+
+#### logout
+
+Log out and revoke access from the CLI.
+
+- **Usage**:
+
+  ```bash
+  canva logout
+  ```
+
+## Next Steps
+
+- [Preview your app in the Canva editor](https://www.canva.dev/docs/apps/previewing-apps/)
+- [Integrate your app with Canva using the Apps SDK](https://www.canva.dev/docs/apps/integrating-canva/)
+
+## Limitations
+
+Once an app is created, it must be managed through Canva's [Developer Portal](https://www.canva.com/developers/apps) and cannot be fully managed via the CLI.
+
+## Updating
+
+To update the CLI to the latest version, run:
+
+```bash
+npm update -g @canva/cli
+```
+
+## Token Storage and Removal
+
+When you log in using the `canva login` command, the Auth token is encrypted and stored locally on your machine. This token is used to authenticate future requests made by the CLI, so you don’t have to log in repeatedly.
+
+### Token Location
+
+The token is stored in a credentials file located in your home directory under the `.canva-cli` folder:
+
+### Removing the Token
+
+To remove the token and log out of the CLI, you can either:
+
+1. Use the `canva logout` command to revoke access and delete the stored token:
+
+   ```bash
+   canva logout
+   ```
+
+2. Manually delete the credentials file:
+
+- **macOS/Linux**: The token is stored in `~/.canva-cli/credentials`.
+- **Windows**: The token is stored in `%USERPROFILE%\.canva-cli\credentials`.
+
+## Contributing
+
+We're in active development and currently do not accept third-party contributions. Please submit any feature requests through the [Canva Developers Community](https://community.canva.dev/).
+
+## License
+
+Refer to the `LICENSE.md` file for licensing details.