Installation¶

A typical installation for Hide consists of 2 parts: a runtime that runs on a local or remote Docker host, and an SDK that interacts with it.

Runtime is the backend system responsible for managing development containers and executing tasks.

SDK is a set of APIs and toolkits designed for coding agents to interact with the codebase.

Prerequisites¶

Docker¶

Hide Runtime requires Docker Engine to be installed on your system. Note that if you intend to use Hide with a remote Docker host, you will need to install Docker Engine on that host.

For installation instructions for your OS, see the Docker Engine documentation.

Runtime¶

The runtime is responsible for managing the development environments, executing tasks, and providing APIs for interacting with the codebase. Runtime can be installed using Homebrew or built from source.

Using Homebrew¶

Add the Hide tap to your Homebrew:
```
brew tap hide-org/formulae
```
Install Hide using the brew install command:
```
brew install hide
```

Building from Source¶

To build Hide from source, follow these steps:

Ensure you have Go 1.22+ or later installed on your system.

Clone the repository:

git clone https://github.com/hide-org/hide.git
cd hide

Build Hide and install it to your $HOME/go/bin directory:
```
make install
```
Note

Make sure that $HOME/go/bin is in your $PATH environment variable e.g. export PATH=$PATH:$HOME/go/bin.
Install LSP server for your language of choice.

For Python, install the pyright package:
```
pipx install pyright
```
Note that we use pipx to install the package globally in isolated environment. After installation run pyright command in the shell to install nodejs if it's missing (Pyright is written in Typescript and it will install nodejs for you).

For JavaScript and TypeScript, install the typescript-language-server package:
```
npm install -g typescript-language-server
```
For Go, install the gopls package:
```
go install golang.org/x/tools/gopls@latest
```

Running Hide¶

After installing Hide, you can start the runtime by running the following command:

hide run

You should see logs indicating that the server is running, something like: Server started on 127.0.0.1:8080. For more options, including how to specify the port, see help:

hide --help

SDK¶

The SDK is a set of APIs and toolkits designed for coding agents to interact with the codebase. It is best used for creating new projects and implementing toolkits for coding agents.

We provide a Python package containing the SDK and some pre-built toolkits:

pip install hide-py

You can also implement your own toolkit by calling the Runtime's APIs directly (see API Reference).

For a quickstart on how to create new projects and interact with them, see the Quickstart guide.