JoonWeb CLI Command Endpoints

🚀 Overview of All CLI Commands #

The **JoonWeb CLI** (`joonweb`) provides commands for scaffolding, running local servers, managing extensions, and deploying apps. ### Quick Command Index | Command | Alias | Description | | - | - | - | | [`joonweb app init`](#section-119) | `create` | Initialize a new JoonWeb app | | [`joonweb app serve`](#section-120) | `dev` | Start development server with auto-tunnel | | [`joonweb refresh`](#section-121) | — | Reset background server and clear port locks | | [`joonweb app regenerate`](#section-122) | `reset`, `reload` | Reload project templates from GitHub | | [`joonweb app generate extension`](#section-123) | `ext` | Generate a new Theme App Extension | | [`joonweb app deploy`](#section-124) | `push` | Deploy app release snapshot | | [`joonweb login`](#section-125) | — | Authenticate with Partner Account | | [`joonweb whoami`](#section-125) | — | Check active login status | | [`joonweb logout`](#section-125) | — | Log out of Partner Account | | [`joonweb update`](#section-125) | `upgrade` | Update CLI to latest version | | [`joonweb uninstall`](#section-125) | `remove` | Uninstall CLI completely |

1. `joonweb app init` (Create App) #

Scaffolds a new JoonWeb app project from official templates. ```bash joonweb app init ``` - **Alias**: `joonweb app create` - **Interactive Options**: 1. Authenticates your Partner account in the browser. 2. Selects **Create a New JoonWeb App**. 3. Chooses tech stack (Node+React, Express, PHP). 4. Asks for **App Name**. - **Output**: Generates project folder with [`joonweb.app.json`](/joonweb-cli/configuration/app-manifest).

2. `joonweb app serve` (Development Server) #

Starts your local development server with automatic HTTPS tunneling and hot reloading. ```bash joonweb app serve [options] ``` - **Alias**: `joonweb app dev` ### Available Options & Flags | Flag | Description | Default | | - | - | - | | `--port <port>` | Specify local server port number | `11014` | | `--no-tunnel` | Disable automatic HTTPS tunnel creation | `false` | | `--no-open` | Disable browser auto-opening for OAuth consent | `false` | ### Usage Examples ```bash # Default serve command joonweb app serve # Custom port without auto browser open joonweb app serve --port 8080 --no-open ```

3. `joonweb refresh` (Port Conflict Fix) #

Resets the background development server and clears locked ports. ```bash joonweb refresh ``` > 💡 **Troubleshooting**: If you encounter `ERR: already port open`, run `joonweb refresh` to terminate leftover background processes and clear port `11014` locks.

4. `joonweb app regenerate` (Reload Templates) #

Reloads all project template files from GitHub while preserving your `joonweb.app.json` config. ```bash joonweb app regenerate ``` - **Aliases**: `joonweb app reset`, `joonweb app reload` - **Use Case**: Updates core SDK files to the latest version without overwriting your custom logic or manifest.

5. `joonweb app generate extension` (App Extensions) #

Generates a new app extension directory. ```bash joonweb app generate extension ``` - **Alias**: `joonweb app generate ext` - **Output**: Generates `extensions/my-extension` with `blocks/`, `components/`, `assets/`, and `joonweb.extension.json`.

6. `joonweb app deploy` (Release Version) #

Deploys an app version snapshot to the JoonWeb platform. ```bash joonweb app deploy [options] ``` - **Alias**: `joonweb app push` ### Available Options & Flags | Flag | Description | Default | | - | - | - | | `--env <env>` | Target deployment environment | `default` | | `--no-release` | Skip creating a new live release version | `false` |

7. Account & Maintenance Commands #

### `joonweb login` Authenticates the CLI with your Partner account. ```bash joonweb login [--shop <domain>] ``` ### `joonweb whoami` Displays your active Partner login status. ```bash joonweb whoami ``` ### `joonweb logout` Logs out and clears cached session credentials. ```bash joonweb logout ``` ### `joonweb update` (Alias: `joonweb upgrade`) Updates the CLI to the latest version. ```bash joonweb update ``` ### `joonweb uninstall` (Alias: `joonweb remove`) Uninstalls the CLI completely. ```bash joonweb uninstall ```

What's Next? #

- ⚙️ **[App Manifest Reference (joonweb.app.json)](/joonweb-cli/configuration/app-manifest)** — Explore all JSON properties. - 🚀 **[Create an App Guide](/apps/create/create-an-app)** — Full step-by-step app development tutorial. - 🎨 **[Create Theme App Extensions](/apps/theme-app-extensions/create-theme-app-extensions)** — Build storefront UI blocks.