Skip to main content

GUI server

Overview​

The faheemcode serve command launches the full Faheem Code GUI server using Docker. This provides the same rich web interface as Faheem Code Cloud, but running locally on your machine.

faheemcode serve

Prerequisites​

  • Docker installed and running
  • Sufficient disk space for Docker images (~2GB)

Basic usage​

# Launch the GUI server
faheemcode serve

# The server will be available at http://localhost:3000

The command will:

  1. Check Docker requirements
  2. Pull the required Docker images
  3. Start the Faheem Code GUI server
  4. Display the URL to access the interface

Options​

OptionDescription
--mount-cwdMount the current working directory into the container
--gpuEnable GPU support via nvidia-docker

Mounting your workspace​

To give Faheem Code access to your local files:

# Mount current directory
faheemcode serve --mount-cwd

This mounts your current directory to /workspace in the container, allowing the agent to read and modify your files.

GPU support​

For tasks that benefit from GPU acceleration:

faheemcode serve --gpu

This requires:

Examples​

# Basic GUI server
faheemcode serve

# Mount current project and enable GPU
cd /path/to/your/project
faheemcode serve --mount-cwd --gpu

How it works​

The faheemcode serve command:

  1. Pulls Docker images: Downloads the Faheem Code runtime and application images
  2. Starts containers: Runs the Faheem Code server in a Docker container
  3. Exposes port 3000: Makes the web interface available at http://localhost:3000
  4. Shares settings: Uses your ~/.faheem-code directory for configuration

Stopping the server​

Press Ctrl+C in the terminal where you started the server to stop it gracefully.

Comparison: GUI server vs web interface​

Featurefaheemcode servefaheemcode web
InterfaceFull web GUITerminal UI in browser
DependenciesDocker requiredNone
ResourcesFull container (~2GB)Lightweight
FeaturesAll GUI featuresCLI features only
Best forRich GUI experienceQuick terminal access

Troubleshooting​

Docker not running​

❌ Docker daemon is not running.
Please start Docker and try again.

Solution: Start Docker Desktop or the Docker daemon.

Permission denied​

Got permission denied while trying to connect to the Docker daemon socket

Solution: Add your user to the docker group:

sudo usermod -aG docker $USER
# Then log out and back in

Port already in use​

If port 3000 is already in use, stop the conflicting service or use a different setup. Currently, the port is not configurable via CLI.

See also​