Terminal

The terminal experience in Kloud Workspace isn't just about getting things done, but about embarking on an exquisite journey through the digital expanse, where beauty and functionality align like the stars in the sky.

Our terminal operates on the zsh shell, meticulously tailored for a seamless and enjoyable experience.

Components

Prompt

The terminal prompt is powered by starship and blends perfectly with our color theme. Modules are shown based on the specific context of the prompt. For instance, the Python module appears only when your current working directory includes a Python-based project.

Some users find the descriptive prompt to be too noisy. To opt-out of some of the prompt modules, you can set any of the following environment variables to either 1 or true:

• WS_TERMINAL_PROMPT_HIDE_DOCKER_CONTEXT: Hides Docker context info in the prompt.
• WS_TERMINAL_PROMPT_HIDE_HOSTNAME: Hides the container hostname in the prompt.
• WS_TERMINAL_PROMPT_HIDE_KUBERNETES_CONTEXT: Hides current Kubernetes context in the prompt.
• WS_TERMINAL_PROMPT_HIDE_NODEJS_VERSION: Hides active Node.js version in the prompt.
• WS_TERMINAL_PROMPT_HIDE_PYTHON_VERSION: Hides active Python version in the prompt.
• WS_TERMINAL_PROMPT_HIDE_USER: Hides the current user in the prompt.

For example, to disable the Docker and Python modules, you could add the following lines to your deployment:

docker run \
  -e WS_TERMINAL_PROMPT_HIDE_DOCKER_CONTEXT=1 \
  -e WS_TERMINAL_PROMPT_HIDE_PYTHON_VERSION=1 \
  ghcr.io/kloudkit/workspace:v0.0.21

Colorful Output

Many CLI tools feature colorization by default (matching the color theme), enhancing your experience with improved readability.

ZSH

The standard shell utilized is zsh, enhanced by the oh-my-zsh framework. Tools and programming languages within the workspace that have corresponding oh-my-zsh plugins are automatically activated for each shell session.

To modify the default set of plugins, adjust the env variables listed below:

• WS_ZSH_PLUGINS: Enables built-in oh-my-zsh plugins.
• WS_ZSH_ADDITIONAL_PLUGINS: Loads additional oh-my-zsh plugins.

Override

docker run \
  -e WS_ZSH_PLUGINS="kubectl npm python pip" \
  ghcr.io/kloudkit/workspace:v0.0.21

Append

docker run \
  -e WS_ZSH_ADDITIONAL_PLUGINS="php" \
  ghcr.io/kloudkit/workspace:v0.0.21