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.

---

Menu bar

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() allows users to access the Process List, SSH Configuration, Manage SBOM, and New Terminal Window.

• The [Preview] button() 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.

• The [Run] button () allows users to manage and execute custom run commands.

Commands

• The [Create Template] button () deploys the currently active container as a template. Deployed templates are made public on the Templates page.

• The [Power] button () 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.

Closing the browser tab does not stop the container. Users must manually click [Stop] to prevent continued credit usage.

Sidebar

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

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.

Side Chat is only available for the container's owner.

Side Chat (Workspace)

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.

➕ Create Files & Folders

Click the button to create new files, folders and sub projects within your project.

Folder Management

• Use the icon to collapse all folders.

• Click the refresh button to update the file tree and keep it in sync.

• Click the 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!

Search

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.

Search

Git

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.

Git Sidebar

Share This Container

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

Container Sharing

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

Help

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

• View All Shortcuts: View all available keyboard shortcuts 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.

Preference

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

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.

Account

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

• 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

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.

Editor

Toggle Panel

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

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]() → [New Terminal Window] or press the default shortcut Alt + Shift + T (macOS ⌥ ⇧ T).

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.

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.

Terminal Tab Control Guide

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

• Refresh() 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() Button: Close Terminal & Terminate Processes

  • Clicking this closes the terminal tab and stops all active processes running within that session.

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).

Bottom bar

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.

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'.

The lint information is only available in the Python container.

Toggle Button

• 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.

Auto-stop