Skip to main content

Configure

Prerequisites​

Launching the GUI server​

Using the CLI command​

You can launch the Faheem Code GUI server directly from the command line using the serve command:

faheemcode serve

This command will:

  • Check that Docker is installed and running
  • Pull the required Docker images
  • Launch the Faheem Code GUI server at http://localhost:3000
  • Use the same configuration directory (~/.faheem-code) as the CLI mode

Mounting your current directory​

To mount your current working directory into the GUI server container, use the --mount-cwd flag:

faheemcode serve --mount-cwd

This is useful when you want to work on files in your current directory through the GUI. The directory will be mounted at /workspace inside the container.

Using GPU support​

If you have NVIDIA GPUs and want to make them available to the Faheem Code container, use the --gpu flag:

faheemcode serve --gpu

This will enable GPU support via nvidia-docker, mounting all available GPUs into the container. You can combine this with other flags:

faheemcode serve --gpu --mount-cwd

Prerequisites for GPU support:

Requirements​

Before using the faheemcode serve command, ensure that:

  • Docker is installed and running on your system
  • You have internet access to pull the required Docker images
  • Port 3000 is available on your system

The CLI will automatically check these requirements and provide helpful error messages if anything is missing.

Using Docker directly​

Alternatively, you can run the GUI server using Docker directly. See the local setup guide for detailed Docker instructions.

Overview​

Initial setup​

  1. Upon first launch, you'll see a settings popup.
  2. Select an LLM Provider and LLM Model from the dropdown menus. If the required model does not exist in the list, select see advanced settings. Then toggle Advanced options and enter it with the correct prefix in the Custom Model text box.
  3. Enter the corresponding API Key for your chosen provider.
  4. Click Save Changes to apply the settings.

Settings​

You can use the Settings page at any time to:

Key features​

For an overview of the key features available inside a conversation, please refer to the Key Features section of the documentation.

Other ways to run Faheem Code​