Skip to content

YouCan CLI for Apps

YouCan CLI is a command-line tool that handles scaffolding, local development, deployment, and versioning for YouCan apps.

Requirements

Commands

CommandDescription
youcan auth loginAuthenticate with your YouCan store
youcan auth logoutLog out from your store
youcan app devStart a local dev server with a public tunnel. (Press 'P' to install)
youcan app deployCreate a version and release it to every installed store
youcan app versions / youcan app releaseList versions, release or roll back
youcan app config link / youcan app config pullManage config files
youcan app env show / youcan app env pullRead 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 dev

If you need to log in manually:

sh
youcan auth login

For issues or feature requests, open an issue on GitHub.