YouCan CLI for Apps
YouCan CLI is a command-line tool that handles scaffolding, local development, deployment, and versioning for YouCan apps.
Requirements
- YouCan Partner account
- Development store set up
- Node.js and pnpm
Commands
| Command | Description |
|---|---|
youcan auth login | Authenticate with your YouCan store |
youcan auth logout | Log out from your store |
youcan app dev | Start a local dev server with a public tunnel. (Press 'P' to install) |
youcan app deploy | Create a version and release it to every installed store |
youcan app versions / youcan app release | List versions, release or roll back |
youcan app config link / youcan app config pull | Manage config files |
youcan app env show / youcan app env pull | Read the app's credentials |
See the command reference for every command and flag.
Usage
Most of the time you interact with CLI through pnpm scripts in the app template:
sh
# Create a new app (includes CLI setup)
pnpm create @youcan/app@latest
# Navigate to the app directory
cd <app-name>
# Start dev server (Press 'P' in the terminal to install on your dev store)
pnpm devIf you need to log in manually:
sh
youcan auth loginFor issues or feature requests, open an issue on GitHub.