README.md

---
title: README
emoji: 👀
colorFrom: blue
colorTo: red
sdk: static
pinned: false
---

<div style="background-color: #2717a1; color: #f8f7fe; border-radius: 8px; padding: 0.5rem 1rem; margin-bottom: 2rem; ">
  <span style="font-weight: 600;">Want to try out the dev mode on Hugging Face Spaces?</span> Use the "Request to join this org" button to join the waitlist.
</div>

<div style="background-color: rgb(255, 241, 209); color: rgb(90, 65, 0); border-radius: 8px; padding: 0.5rem 1rem; margin-bottom: 2rem; ">
  <span style="font-weight: 600;">WARNING:</span> This feature is still in an <span style="font-weight: 600;">alpha stage</span>.
  You should expect bugs and instabilities.
  If you encounter issues with Spaces dev mode, please report them in the <a href="/spaces/dev-mode-explorers/README/discussions/new">Community tab</a> of this Organization card 🤗
</div>

# Spaces Dev Mode (feature preview)

**Members of this organization have early access to the new "Dev Mode" feature on Spaces.**  

## About Dev Mode

When the "Dev mode" is enabled on Space, you can connect to it using SSH or VS Code.

You can make changes to your application code, run some debug tools, ...

![image/png](https://cdn-uploads.huggingface.co/production/uploads/5fcfb7c407408029ba3577e2/ME0eqODONxjInE9tfmTDc.png)

Changes reflect to your Space after you hit the "Refresh" button.

When you are done, you can persist your changes using `git` as you would normally do when developping locally.


## How to enable the dev mode

Go to your Space's settings and click on "Enable dev mode".

![image/png](https://cdn-uploads.huggingface.co/production/uploads/5fcfb7c407408029ba3577e2/QvLqvKxEzq8v0cpxQQ5An.png)

## Limitations

The dev mode is currently not available for static Spaces.

### Docker Spaces

Dev mode is supported for Docker Spaces. However, your Space needs to comply with the following rules for the Dev mode to work properly:

- `apt-get` must be installed in the container (base images such as `debian` or `ubuntu` have that package by default).
- The Dockerfile must contain a `CMD` instruction for startup.

Checkout [Docker's documentation](https://docs.docker.com/reference/dockerfile/#cmd) about the `CMD` instruction for more details.