Skip to main content
This guide will help you launch Gitlantis and explore your first project in 3D.

​
Prerequisites

Before you begin, make sure you have:
  • VS Code version 1.80.0 or higher
  • Gitlantis extension installed (installation guide)
  • A workspace or folder open in VS Code

​
Launch Gitlantis

1

Open the Command Palette

Press the keyboard shortcut for your operating system:
  • macOS: Cmd + Shift + P
  • Windows/Linux: Ctrl + Shift + P
2

Search for Gitlantis

Type Gitlantis in the command palette and select the Gitlantis command.
The command is registered as gitlantis.start internally, but appears as “Gitlantis” in the command palette.
3

Explore your project

The 3D ocean world will open in a new webview panel. You’ll see:
  • Your current directory rendered as a 3D ocean
  • Folders appearing as tall lighthouses
  • Files appearing as shorter buoys
  • A boat you can control to navigate
Once Gitlantis is open, you can navigate using your keyboard:
Movement:
  • W or ↑ - Move forward
  • S or ↓ - Move backward
  • A or ← - Turn left
  • D or → - Turn right
Actions:
  • Shift + Enter - Open file/folder when near it
  • Escape - Go back to parent directory
  • H - Toggle horn sound
  • F - Toggle minimap fullscreen mode

​
Open Files and Folders

To interact with files and folders:
  1. Navigate your boat close to a lighthouse (folder) or buoy (file)
  2. When you’re close enough, you’ll see a prompt: “Press SHIFT+ENTER”
  3. Press Shift + Enter to open the file in your editor or enter the folder
The collision detection activates when you’re within the configured collision radius (default: 100 units). You’ll see visual feedback when you’re close enough.

​
Customize Your Experience

Press Cmd/Ctrl + Shift + P and search for “Gitlantis Settings” or access settings from within the 3D world.

​
Quick Settings

Display Options

Toggle minimap, compass, and breadcrumbs visibility

Boat Customization

Change boat colors and adjust movement speed

Physics Tweaks

Adjust acceleration, turning, and floating behavior

Audio Controls

Control ocean wave and boat horn volume
For detailed configuration options, see the Configuration Guide.

​
Automatic Restoration

Gitlantis automatically saves your session state:
  • When you close VS Code with Gitlantis open, it will automatically relaunch on startup
  • Your last visited directory and settings are preserved
  • The restoration happens after VS Code finishes starting up (configurable delay: 500ms)
If you change workspace folders while Gitlantis is active, the extension will automatically restart with a 300ms delay to load the new workspace.

​
Troubleshooting

Make sure you have a workspace or folder open in VS Code. Gitlantis requires an active workspace to display the file system.
Click inside the Gitlantis webview panel to ensure it has focus. Keyboard controls only work when the panel is active.
Try adjusting the number of visible nodes in settings or reducing the minimap size. Large directories with many files may impact performance.
For more troubleshooting help, see the Troubleshooting Guide.

​
Next Steps

Core Features

Learn about 3D exploration, navigation, and visualization

Navigation Guide

Master boat controls and navigation techniques

Customization

Personalize your boat and adjust physics settings

Configuration

Explore all available settings and options

Build docs developers (and LLMs) love

Get started for freeTalk to us