Hub documentation

Tabby on Spaces

Hugging Face's logo
Join the Hugging Face community

and get access to the augmented documentation experience

to get started

Tabby on Spaces

Tabby is an open-source, self-hosted AI coding assistant. With Tabby, every team can set up its own LLM-powered code completion server with ease.

In this guide, you will learn how to deploy your own Tabby instance and use it for development directly from the Hugging Face website.

Your first Tabby Space

In this section, you will learn how to deploy a Tabby Space and use it for yourself or your orgnization.

Deploy Tabby on Spaces

You can deploy Tabby on Spaces with just a few clicks:

Deploy on HF Spaces

You need to define the Owner (your personal account or an organization), a Space name, and the Visibility. To secure the api endpoint, we’re configuring the visibility as Private.

Duplicate Space

You’ll see the Building status. Once it becomes Running, your Space is ready to go. If you don’t see the Tabby Swagger UI, try refreshing the page.

Swagger UI

If you want to customize the title, emojis, and colors of your space, go to “Files and Versions” and edit the metadata of your README.md file.

Your Tabby Space URL

Once Tabby is up and running, for a space link such as https://hf.xwall.us.kgm/spaces/TabbyML/tabby, the direct URL will be https://tabbyml-tabby.hf.space. This URL provides access to a stable Tabby instance in full-screen mode and serves as the API endpoint for IDE/Editor Extensions to talk with.

Connect VSCode Extension to Space backend

  1. Install the VSCode Extension.
  2. Open the file located at ~/.tabby-client/agent/config.toml. Uncomment both the [server] section and the [server.requestHeaders] section.
    • Set the endpoint to the Direct URL you found in the previous step, which should look something like https://UserName-SpaceName.hf.space.
    • As the Space is set to Private, it is essential to configure the authorization header for accessing the endpoint. You can obtain a token from the Access Tokens page.

Agent Config

  1. You’ll notice a ✓ icon indicating a successful connection. Tabby Connected

  2. You’ve complete the setup, now enjoy tabing!

Code Completion

You can also utilize Tabby extensions in other IDEs, such as JetBrains.

Feedback and support

If you have improvement suggestions or need specific support, please join Tabby Slack community or reach out on Tabby’s GitHub repository.

< > Update on GitHub