Logo

Install Divekit and verify your system

Orientation and Setup

Install Divekit and verify your system

Install Divekit CLI first, then verify that the local environment is healthy enough for the course.

Before you install Divekit, make sure you have:

  • a supported operating system: Linux, macOS, or Windows
  • access to a GitLab instance
  • permission to create groups and repositories on the target GitLab instance

You do not need to finish token setup yet.
The CLI will ask for that in the authentication lesson.

Install

Use the guided installer as the default path in this course.

On Unix-like systems, run:

curl -fsSL 'https://gitlab.git.nrw/api/v4/projects/divekit%2Fdivekit-cli/repository/files/scripts%2Finstall.sh/raw?ref=main' | bash

This is the main installation path for the beginner course.

Show alternative installation paths

If you already have a local binary from a build or release artifact:

./divekit install

On Windows, the equivalent local install step is:

./divekit.exe install

Install location

Divekit uses a managed user-level installation.

  • Unix: prefers ~/.local/bin, otherwise ~/.divekit/bin
  • Windows: installs into the user-level Divekit directory

You do not need a system-wide installation for this course.

What a healthy result looks like

After installation, verify the setup:

# Verify the installation and environment
divekit doctor

For this course, a good success state is:

  • divekit doctor runs and exits successfully
  • the binary is callable from your shell
  • any remaining warning is about host or token setup, not about the installation itself

A token-related warning may still appear at this point. That is acceptable until the next lesson.

Example shape of a healthy result at this stage:

[✓] Divekit Home Directory - Divekit home directory is properly initialized
[✓] Configuration File - Configuration system is accessible
[✗] GitLab Connection & Token - GitLab project target checks failed
    • Host https://gitlab.git.nrw reachable
    ! Warning: Host gitnrw is missing credentials
    • Run 'divekit auth' to refresh credentials
[✓] Environment - Environment info

If you see only the authentication-related warning, continue to the next lesson.
If you see installation or PATH errors, fix those before continuing.

Quick interpretation

What you see How to read it What to do next
doctor runs and only GitLab auth is still unresolved Normal at this stage Continue to host setup
doctor runs and core environment checks are healthy Good install state Continue
divekit: command not found or similar PATH errors Not a normal warning Fix the installation before continuing
missing binary or broken install location Install failed or shell was not refreshed Reopen the terminal or reinstall

Common failures

What to try

Possible reasons:

  • the shell has not reloaded its PATH
  • the terminal session is still using the old environment
  • the installer did not finish correctly

If you can open a new terminal, do that first and run:

divekit doctor

If you are staying in the current shell session, reload the shell config that matches your shell:

# If the installer says "Updated PATH in /path/to/file",
# source exactly that file.
source ~/.profile

# Common alternatives
source ~/.zshrc
source ~/.bashrc

If the binary was installed but the current shell still does not see it, add the managed install path manually for the current session:

export PATH="$HOME/.local/bin:$PATH"
export PATH="$HOME/.divekit/bin:$PATH"
hash -r

Then try again:

divekit doctor

In container or temporary Bash sessions, ~/.profile is often the important file, not ~/.bashrc.
hash -r only helps after your current shell has the correct PATH.

If that still fails, inspect your shell startup files and repeat the installation.

What to try

Some institutions restrict direct script execution or block the curl | bash path.

If that happens, do not invent a new manual workflow in the middle of the lesson.

Instead, use one of the alternative installation paths above:

  1. download the correct release archive
  2. extract the binary
  3. run the local install step with ./divekit install or ./divekit.exe install
What to try
That is expected if you have not configured a GitLab host yet. Continue to the next lesson.

Check

Install Divekit, then run:

divekit doctor
Suggested answer
The core checks pass and divekit is callable from your shell. A warning about missing GitLab credentials is expected here — the next lesson configures the host and token.
Suggested answer
Anything that breaks the CLI itself: divekit: command not found, PATH problems, or a failed installation. Only authentication warnings may wait until the next lesson.