Get started

Get started

Artemis runs on Ubuntu 24.04 with the GNOME desktop. Setup is one script, a log-out, and one command to start.

Before you start

Artemis is in active development. These are the same steps the team runs on the demo laptop. The core runs on your computer, and the island at the top of your screen connects to it.

What you need

  • Ubuntu 24.04 (GNOME 46) and a microphone
  • Orca, the screen reader that comes with Ubuntu (turn it on or off with Super+Alt+S)
  • Git
  • An Anthropic API key, for Claude
  • Optional: an ElevenLabs API key, for Artemis's own voice, Morgan. Without one, the offline voice speaks.

1. Set up once

Get the code and run the setup script with the island. It says what each step does before it does it: it installs the microphone library (asks for your password), installs uv if you agree, sets up Python, downloads the speech models, and copies in and turns on the island.

git clone https://github.com/BU-Hackathonz/Artemis.git
cd Artemis
bash infra/setup-ubuntu.sh --extension-dir client/prototypes/water-desktop/artemis-water@bu-hackathonz.github.io

Log out and back in, so GNOME loads the island. Then check it is running:

gnome-extensions info artemis-water@bu-hackathonz.github.io

It should say State: ACTIVE. If the setup script printed a gnome-extensions enable line, run that first.

2. Start Artemis

From the Artemis folder, start the core with Claude, “Hey Artemis” and conversation mode on:

ARTEMIS_LISTEN_MODE=wake infra/start.sh --agent claude --conversation

It asks for your Anthropic API key with a hidden prompt and never saves it. At Workspace ID, press Enter unless your key needs one. Wait for Core is ready., then say “Hey Artemis” and your request.

For the Morgan voice, set your ElevenLabs key in that terminal first, without it showing on screen or in your history:

read -rsp 'ElevenLabs key: ' ELEVENLABS_API_KEY; echo; export ELEVENLABS_API_KEY

Keep your keys to yourself: never paste them into a chat, an issue or a file in the repository. To stop Artemis, press Ctrl+C in that terminal.

3. Talking to it

  • Say “Hey Artemis” and your request, or hold Ctrl+Shift+Space while you speak. Push-to-talk always works.
  • Approve a change with Enter and reject it with Escape. With conversation mode on, you can also say “approve” for a clean change in your project once Artemis has read it to you.
  • Say “stop” or “Hey Artemis” to interrupt it while it speaks.
  • Ctrl+Alt+M turns all listening off and on.

Updating

Pull, run the setup script again (it replaces the installed island), log out and back in, and start Artemis again:

git pull --ff-only
bash infra/setup-ubuntu.sh --extension-dir client/prototypes/water-desktop/artemis-water@bu-hackathonz.github.io