YouCan CLI for Apps
YouCan CLI is a command-line tool designed to simplify the development process of YouCan apps. It assists in quickly generating, developing, and managing YouCan apps.
This documentation explains how to use YouCan CLI for app development. To learn how to use YouCan CLI for themes, refer to the following documentation:
Requirements
- YouCan Partner Account: If you don't already have an account, apply for one here.
- Once logged in, set up your Development Store.
- Node.js: Install the latest version of Node.js.
- Package Manager: Have npm or pnpm installed on your system.
Installation
To start using YouCan CLI, install it globally on your system. This allows you to access CLI commands from any directory, run:
sh
npm install -g @youcan/cli@latest
Run the following command to verify the installation by checking the available commands
sh
youcan --help
YouCan CLI includes a set of commands that handle the complete setup for YouCan Apps:
Command | Description |
---|---|
auth login | Authorize a YouCan Store |
auth logout | Logout from a YouCan store |
app generate | Generate an app extension |
app dev | Start a local server for developing your app in draft mode |
app install | Generate an app installation URL |