> For the complete documentation index, see [llms.txt](https://docs.viverse.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.viverse.com/standalone-app-publishing/publishing-to-viverse-with-the-cli.md). # Publishing to VIVERSE with the CLI *** The [VIVERSE CLI](https://www.npmjs.com/package/@viverse/cli) can be used to publish any working WebGL build to the VIVERSE platform after an authentication process. ### Installation Using npm: ``` npm install -g @viverse/cli ``` > **Note:** This CLI requires Node.js version 22.15.0 or higher. ### Authentication Login to VIVERSE platform: ``` viverse-cli auth login ```

Or directly pass in login credentials for CI/CD integration: ``` viverse-cli auth login -e -p ``` In such CI/CD environments, it's recommended to use environment variables: ``` viverse-cli auth login -e $VVS_EMAIL -p $VVS_PASSWORD ``` After login, check your authentication status: ``` viverse-cli auth status ```

And to logout: ``` viverse-cli auth logout ``` After [install and authentication](/standalone-app-publishing/publishing-to-viverse-with-the-cli.md), the VIVERSE CLI can be used to publish any working WebGL build to the VIVERSE platform after an authentication process. When publishing, you'll either access your existing projects, or create a new one. ## Creating Applications You can use the VIVERSE CLI to create a new application directly: ``` viverse-cli app create ```

Or specify a name: ``` viverse-cli app create --name ``` Alternately, you can use the [VIVERSE Studio](https://studio.viverse.com/) workflow to create an application ID:

From the Upload section, click the light blue "Create New World" button in the top right to open this modal.

Once created, your App ID will display on the world page.

#### **Listing Applications** Once authenticaed, you can view your account's available application list: ``` viverse-cli app list ``` The output will be displayed in a table format with the following columns: * ID: Application identifier * STATE: Application state * TITLE: Application name * URL: Application preview URL ## Publishing Content Publishing content requires two inputs: 1. **App ID** — the target application to publish to (**required**) 2. **Content path** — the directory containing your content (optional if you're already in that directory) **Option 1: Specify content path** ``` viverse-cli app publish --app-id ``` **Option 2: From within content directory** ``` viverse-cli app publish --app-id ``` > **Note:** The App ID is required. You can use the `viverse-cli app list` command to query your existing application IDs, or view the IDs of newly created applications after using `app create`. > **Important:** After uploading content successfully, you'll need to visit the Creator Studio website to complete the review and publishing process. > **Warning:** The `` parameter MUST point to your **build output folder** and NOT your source code folder. Publishing source code folders (containing `src/`, `node_modules/`, or development files like `.tsx`, `.jsx`, `.vue`, `.unity`, etc.) will result in non-functional content and deployment failures. ### Content Approval For security purposes, creators must submit their application for approval --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.viverse.com/standalone-app-publishing/publishing-to-viverse-with-the-cli.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.