# Codebox User Manual Codebox is **UCloud's cloud development box** based on the AstraFlow star map Sandbox. You only need to provide a Git repository address, and Codebox will pull up a development environment with a pre-installed AI programming assistant in the cloud and access it directly through the browser - no need to install or configure the environment locally. ## What it can do - **Pull up the environment with one click**: Create a development sandbox from the Git repository and automatically clone the code to `/home/user/app`. - **Built-in AI assistant**: Claude Code, Codex, and Jupyter-AI are pre-configured in the environment and can be used out of the box. - **Browser Ready**: After creation, you will get the access address and password, open the browser and log in to start coding. - **Pause/Resume on Demand**: Automatically pause when idle and automatically resume when accessed, saving resources. ## Two scenarios | Scenario | Type | Description | | ------- | ----------------- | ------------------------------------------------------------ | | VSCode | `codebox-vscode` | Web version of VSCode based on code-server, suitable for general coding and AI pair programming | | Jupyter | `codebox-jupyter` | Data science environment based on JupyterLab, with built-in jupyter-ai panel | ## Quick start The top of the page shows the total number of CodeBoxes, the running number, and the paused number, and each instance is shown in the form of a card below. [![CodeBox Page Overview](https://cdnv2-cache.udelivrs.com/2026/07/526b01ee3fd2da6334cc553b2257eb6c_1784196104135.png)](https://cdnv2-cache.udelivrs.com/2026/07/526b01ee3fd2da6334cc553b2257eb6c_1784196104135.png) - **Running**: Sandbox vCPU and memory resources are being used and can be opened directly. - **Paused**: The running resources are frozen and do not consume sandbox vCPU and memory resources; click "Start" when needed. - **Auto-suspend**: A running instance will be automatically suspended after being idle for 1 hour. --- ## Create Codebox > If there is no access link after creation, it usually means that the environment is still being prepared, please refresh the page later. If the configuration fails, the instance may be automatically cleaned up; please check the warehouse address and API Key before re-creating it. After clicking "Create CodeBox", follow the instructions below to fill out the form. [![Create CodeBox form](https://cdnv2-cache.udelivrs.com/2026/07/d1a67a3e1cc0adb56bf7a883bca58a1f_1784196104129.png)](https://cdnv2-cache.udelivrs.com/2026/07/d1a67a3e1cc0adb56bf7a883bca58a1f_1784196104129.png) | Field | How to fill in | | --- | --- | | Name | Enter a name for easy identification, such as `demo-vscode`. It is recommended to reflect both the project and the environment. | | Environment | Select `VS code` or `Jupyter`. | | Git warehouse address | Enter the Git warehouse address that Codebox needs to pull. | | Access password | Set the password used to log in to the development environment, please keep it safe. | | API Key | Select an existing key from the drop-down list; click "Create API key" if no key is available. | After filling in, click "Create". The system will begin preparing the development environment, including pulling code, configuring the AI ​​assistant, and starting services. This process is asynchronous. Closing the creation window does not mean that the environment is ready for use. Please refer to the instance status. ## Open the development environment > The access link and password can be used to enter your development environment. Please do not publish it in public documents, group chats or code repositories. After the instance becomes "Running", you can view and manage it in the card, or click the copy button next to the access link and paste the link into a browser to open it. The password is hidden by default and can be displayed using the Show or Copy buttons to the right of the password. [![The operating area of ​​the running instance, the instance information is sample data](https://cdnv2-cache.udelivrs.com/2026/07/6c0eec1186a21c639fa8dd1402683b34_1784196104132.png)](https://cdnv2-cache.udelivrs.com/2026/07/6c0eec1186a21c639fa8dd1402683b34_1784196104132.png) 1. Click "Open" to enter the VS Code or Jupyter login page. 2. Enter the access password set when creating. 3. After logging in, view the pulled warehouse code in the `/home/user/app` directory. ## Management instance ### Pause and start - After clicking "Pause" on a running instance, the running resources will be frozen, and the code and configuration will be retained. - Click "Start" for the paused instance and wait for the status to return to "Running" before opening it again. - The instance will be automatically suspended if it is idle for 1 hour, and can be restarted when you need to continue using it. ### delete Click Remove to permanently remove CodeBox. Before deleting, please confirm that important code has been submitted and pushed to the remote warehouse; the deletion operation cannot be restored. ## Access and use ### Access address rules > The address is subject to the access address displayed in the list. The service is started in the sandbox and can be accessed through the same rules. Address format: `{port}-{SandboxID}.cn-wlcb.sandbox.ucloudai.com` - VSCode: port `8080`, no suffix - Example: `8080-sbx-xxx.cn-wlcb.sandbox.ucloudai.com` - Jupyter: port `8888`, suffix `/lab` - Example: `8888-sbx-xxx.cn-wlcb.sandbox.ucloudai.com/lab` ## Limitations and constraints - **Region**: Currently only `cn-wlcb` (WCLB) is supported and cannot be switched. - **Password Length**: Maximum 50 characters. - **Name Length**: Maximum 50 characters. - **Type**: Only supports VSCode and Jupyter. - **Required fields**: The name when created, Git warehouse address, type, APIKey, and login password cannot be empty. - **Asynchronous Semantics**: The successful creation of the submission does not mean that the environment is immediately available. It must be subject to the status changing to `running`. --- ## FAQ **Q: After the creation is successful, the access address is empty? ** A: The instance is still at `preparing`. Please wait for the status to change to `running` in the list, and the access address will be displayed subsequently. **Q: The status shows running, but the address cannot be opened? ** A: The service may not be fully ready yet, **mainly limited by the speed of the Git Clone warehouse**. The system will automatically correct this situation to `preparing`, please check again later. If it will not be restored for a long time, it is recommended to delete and recreate it. **Q: The AI ​​assistant is not responding? ** A: AI configuration is written asynchronously in the background. Please confirm that the status is `running`, and check whether the APIKey filled in when creating is valid. **Q: Will data be lost after suspension? ** A: No. Pause only recycles running resources, and the code and configuration are retained; it will be automatically restored when accessed again. **Q: Can’t see it in the list after creation? ** A: It may be that the background configuration failed, causing the sandbox to be automatically destroyed. Please check whether the Git repository address is accessible, whether the APIKey is valid, and then create it again.