# Workspace

Arkain's **Workspace** is an IDE (Integrated Development Environment) designed to help you efficiently develop software. It provides features such as editing, building, testing, and deploying software. The main components of the Workspace are as follows. 

<figure><img src="/files/VxBRPQ3pBkL4TR1UctXO" alt=""><figcaption></figcaption></figure>

***

## Menu bar <a href="#menu-bar" id="menu-bar"></a>

The Menu bar is where you perform general operations on your Arkain Workspace. It includes the following buttons, from left to right

* The **\[Menu]** button(<img src="/files/KjLazVTzPdUTRwLQkwea" alt="" data-size="line">) allows users to access the **Process List**, **SSH Configuration**, **Manage SBOM**, and **New Terminal Window**.

<figure><img src="/files/xFoe8r6lpKJaxNO1XpXo" alt=""><figcaption></figcaption></figure>

* The **\[Preview]** button(<img src="/files/h8aZuIYnOW1kT3QfmhcI" alt="" data-size="line">) allows users to preview their project within the Workspace or in a new tab. It also provides options for configuring the execution URL and port settings.

<figure><img src="/files/oFN6gvJgR1574n7sLOI2" alt=""><figcaption></figcaption></figure>

* The **\[Run]** button (<img src="/files/k6FJ4jopqjmj5u9FgRgt" alt="" data-size="line">) allows users to manage and execute custom run commands.

{% content-ref url="/pages/nDNmTx73KHtMIvd4On5f" %}
[Commands](/user-guide/workspace/commands.md)
{% endcontent-ref %}

<figure><img src="/files/PBjNpu3fiWu6gzxWAC7O" alt=""><figcaption></figcaption></figure>

* The **\[Create Template]** button (<i class="fa-up-from-line" style="color:$info;">:up-from-line:</i>) deploys the currently active container as a template. Deployed templates are made public on the [Templates page](https://arkain.io/template).
* The **\[Power]** button (<i class="fa-power-off" style="color:$info;">:power-off:</i>) allows users to manage the container status through **Restart** and **Stop** options.
  * **Exiting:** Users can exit the Workspace by simply closing the web browser tab.
  * **Stop:** The **\[Stop]** button terminates all running processes and stops further credit deduction.
  * **Restart:** The **\[Restart]** button reboots the container to refresh the environment.

{% hint style="warning" %}
Closing the browser tab does not stop the container. Users must manually click **\[Stop]** to prevent continued credit usage.
{% endhint %}

## Sidebar <a href="#sidebar" id="sidebar"></a>

The Sidebar is an area that helps you easily access key features needed for development.

### &#x20;<img src="/files/0TiJrt6TE8ArkqBY0xdL" alt="" data-size="line"> Side Chat

Clicking on the **\[Side Chat]** button will open a Side Chat on the left side of the Workspace, where you can converse with the **AI Code Assistant**.

<figure><img src="/files/eWj1rIxVNGOlsKdHDUay" alt=""><figcaption></figcaption></figure>

{% hint style="warning" %}
Side Chat is only available for the container's **owner**.
{% endhint %}

{% content-ref url="/pages/eGdbEwISgVyHNNZbAJep" %}
[Side Chat (Workspace)](/user-guide/workspace/side-chat-workspace.md)
{% endcontent-ref %}

### <img src="/files/Lk5k5dVEU7LMnAjY5r3C" alt="" data-size="line"> Project

The **\[Project]** button opens the Project Sidebar area. The project sidebar is a type of file explorer that allows you to create, edit, and delete project files and folders.

You can click on files, such as a README or source code, to open them in the editor.

<figure><img src="/files/XoUCXeDeFurOWIjtwyG2" alt=""><figcaption></figcaption></figure>

#### ➕ **Create Files & Folders**

Click the <img src="/files/dhfvxibwH6SA5CGuoD78" alt="" data-size="line"> **button** to create new **files, folders** and sub projects within your project.

#### **Folder Management**

* Use the <img src="/files/TKTepuOtudegQofGi1uc" alt="" data-size="line"> **icon** to collapse all folders.
* Click the <img src="/files/56IMxtpOgU1QVUSy9U6W" alt="" data-size="line"> **refresh button** to update the file tree and keep it in sync.
* Click the <img src="/files/il5pq4SkqH9OPFDa9boc" alt="" data-size="line"> **more actions button** to access project-level utilities, such as renaming the container, uploading local files or folders, and downloading items from the workspace.

#### **Right-Click for File Actions**

Right-click on a file to access all available file-related features, including renaming, deleting, moving, and more!&#x20;

### <img src="/files/mcnjx4NnTkNmEK1r9xxu" alt="" data-size="line"> [Search](/user-guide/workspace/search.md)

The **\[Search]** button opens the Search Sidebar area.

Enter a keyword in the input field at the top to view all matching results, grouped by file. This is useful when searching across your entire project.\
Each result displays the file name, line number, and matching content. You can quickly jump to the relevant location by clicking the matching result.

<figure><img src="/files/yd5z8xOJHDBX9p7y3uTe" alt=""><figcaption></figcaption></figure>

{% content-ref url="/pages/bfWKiX94ddLl2PD51dqr" %}
[Search](/user-guide/workspace/search.md)
{% endcontent-ref %}

### <img src="/files/ylhClbu0UTV9T4dODbVC" alt="" data-size="line"> [Git](/user-guide/workspace/source-code-management-with-git/git-sidebar.md)

It opens Git, a distributed version control system, in the Sidebar to track and synchronize changes to files. Arkain provides support for most common Git commands.

<figure><img src="/files/XGxhDCXrApaaoRdbq5JS" alt=""><figcaption></figcaption></figure>

{% content-ref url="/pages/zrB2kVZvKtZLOahsLJWh" %}
[Git Sidebar](/user-guide/workspace/source-code-management-with-git/git-sidebar.md)
{% endcontent-ref %}

### <img src="/files/hzGQP0BFMrsjxcy6nvn7" alt="" data-size="line"> [Share This Container](#share-this-container-sidebar)

You can share your container with other Arkain users to collaborate or showcase your projects.

<figure><img src="/files/3IYDyGI8QzXlLTxm8Ook" alt=""><figcaption></figcaption></figure>

{% content-ref url="/pages/DV1g0ryp8T03Q2LFsaZn" %}
[Container Sharing](/user-guide/workspace/collaboration/container-sharing.md)
{% endcontent-ref %}

### <i class="fa-bell">:bell:</i> Notifications

You can receive real-time notifications of various events occurring in your project.

* **Mark as Read**: Click the **\[Read]** button on individual notifications or use the **\[Read All]** button to clear all notifications
* **Category Filter**: View notifications by category using All, Containers, Collaboration, and Credit tabs

### <img src="/files/kOjf5tGvhY8ZTnpt6wLS" alt="" data-size="line"> Help

Here, you can find Arkain's features, view shortcuts, and access help.

<figure><img src="/files/27aIgPxbmzwbowKXbrn6" alt=""><figcaption></figcaption></figure>

* **View All Shortcuts**: View all available [keyboard shortcuts](/user-guide/workspace/keyboard-shortcut.md) in Workspace.
* **Notice**: Check the latest Arkain announcements.
* **Guides**: Access Arkain guides.
* **What's New**: View the latest updates and new features via Arkain Release Note.
* **Discord**: Join the Arkain community and connect with other users.
* **Contact Us**: Click to open a chat window for direct support. Unread responses can be identified by the notification dot on the Help button and the chat bubble in the bottom right corner.

### &#x20;<img src="/files/ocubsqrDtnvFFUzs0hXz" alt="" data-size="line"> Preference

You can open the project settings tab. You can change the editor, terminal, theme styles, and Image Viewer settings.

<figure><img src="/files/hnZi7BhcjXHSKjM5mGJH" alt=""><figcaption></figcaption></figure>

### <img src="/files/7kBlEa7T316YqTIJnA6F" alt="" data-size="line"> Credit Usage

You can check your real-time credit balance and estimated uptime for the current container. You can monitor specific credit consumption for running containers, storage, and traffic, as well as purchase additional credits or view your complete billing history.

<figure><img src="/files/Ztef6bhYu4lr7EobFkvV" alt=""><figcaption></figcaption></figure>

### <img src="/files/dsbr6RUEt4MtMHpxOhDq" alt="" data-size="line"> Account

You can navigate to the page where you can manage your member profile and container information.

<figure><img src="/files/NmfLSVPMjIXAYeMK1Wwo" alt=""><figcaption></figcaption></figure>

* **Account** : You can navigate to the Account Settings page to edit your account information.
* **Container Info** : You can navigate to the Container Settings page to configure detailed container settings.
* **Go to Container Console :** Exits the Workspace and returns you to the Dashboard page.
* **Log out** : You can log out.

## [Editor](/user-guide/workspace/editor.md) <a href="#editor" id="editor"></a>

The Editor section of the Workspace shows the content of the file you have currently selected. From the top-right corner of the Editor, you can manage multiple open file tabs and access additional actions.

{% content-ref url="/pages/vmZxNnEdEoNqR9PrqHox" %}
[Editor](/user-guide/workspace/editor.md)
{% endcontent-ref %}

## Toggle Panel <a href="#terminal" id="terminal"></a>

In Arkain's toggle panel, you can use the terminal.

### <img src="/files/SzNiRugmOpm3jleaAmrs" alt="" data-size="line"> Terminal

**Arkain** provides a built-in terminal, so developers who are familiar with command-line interfaces can use it for advanced tasks.

By default, the terminal is available as the Terminal tab in the toggle Panel of the Arkain interface. To open it in a new terminal window, go to **\[Menu]**(<img src="/files/PuNfN4ks9KZeSLNX5wDc" alt="" data-size="line">) → **\[New Terminal Window]** or press the default shortcut <kbd>Alt</kbd> + <kbd>Shift</kbd> + `T` (macOS <kbd>⌥</kbd> <kbd>⇧</kbd> <kbd>T</kbd>).&#x20;

You can open the Terminal in a new window by right-clicking on a folder or file in the Project Sidebar and clicking the **\[Open Terminal with this location]** menu, which will automatically take you to the folder.

<figure><img src="/files/0avg8XqWtBuSzTrgWNKP" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
As a docker container-based service, Arkain does not support system privileges for containers due to security policy. Therefore, commands that access system resources such as `ufw`, `systemctl`, `docker`(docker in docker) cannot be used.
{% endhint %}

#### Terminal Tab Control Guide&#x20;

Manage your terminal sessions using the buttons located on the terminal tab.

* Refresh(<img src="/files/mAcIvnS7sUVG0UP4RCDQ" alt="" data-size="line">) Button: Restart Terminal Session
  * Clicking this will re-initialize the current terminal session.
  * Use this to reset the session or apply new environment settings.
* Close(<img src="/files/6HnTl69KILqtSydQAOu4" alt="" data-size="line">) Button: Close Terminal & Terminate Processes
  * Clicking this closes the terminal tab and stops all active processes running within that session.

{% hint style="info" %}
If you need a process to continue running after closing the tab, we recommend using the default terminal or executing the task with background commands (e.g., `nohup`, `pm2`).
{% endhint %}

## Bottom bar <a href="#terminal" id="terminal"></a>

The bottom bar is an area that provides various tools and information to enhance convenience when using Arkain. It includes the editor's code Lint and Editor information, along with the Toggle Panel and Auto-stop toggle buttons.

#### Edit Status Area

The Edit Status Area displays linting check results and editor line information. **Lint** is a tool that identifies and notifies errors related to syntax and code style in the source code.&#x20;

The **Edit Status Area** shows, from left to right, the **lint errors**, **lint warnings**, and the total number of lines in the editor along with the current cursor position in the format of '`number:number`'.

<figure><img src="/files/NDDQaI0he5EITXdLvMEU" alt="" width="86"><figcaption></figcaption></figure>

{% hint style="warning" %}
The lint information is only available in the Python container.
{% endhint %}

### **Toggle Button**

<figure><img src="/files/RGu6FHkYIns6PI7gBfxe" alt=""><figcaption></figcaption></figure>

* **Terminal**: You can open and close the Terminal panel. Closing the Toggle Panel allows you to focus more on your code.
* **Auto-stop**: You can toggle the feature to automatically stop container usage when the browser is closed.

{% content-ref url="/pages/H5tvZEDDLWhoRRpBopgi" %}
[Auto-stop](/user-guide/dashboard/container/container-management/container-settings/auto-stop.md)
{% endcontent-ref %}


---

# Agent Instructions: 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:

```
GET https://docs.arkain.io/user-guide/workspace.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.