# Getting started

> How to install and run Vukem Video, and what you can do today while it is in the BETA phase.

Source: https://alexgalhardo.github.io/vukem-video/docs/quick-start/

**Warning:**
Vukem Video is in its BETA phase. You can import media, edit, caption and export from the editor, the CLI or an agent, and each release adds more. Read the [changelog](/changelog) for what the version you installed can do.

## What you can do today

- Import media, cut and arrange it on a timeline, add text and captions, and export a verified MP4.
- Save a project as a template and start new projects from it.
- Let an agent do the same through the MCP server or the CLI.
- Read the planning documents in the [repository](https://github.com/AlexGalhardo/vukem-video/tree/main/docs): requirements, architecture decisions and specifications.

## Install

The product runs only on your machine. Each [release](https://github.com/AlexGalhardo/vukem-video/releases) attaches:

- installers of the local server, which install `vukem-video` and a shortcut that starts the server and opens the editor in your browser; uninstalling removes the program and keeps your workspace:
  - Windows 11: `vukem-video_<version>_windows_amd64_setup.exe`
  - Debian and Ubuntu: `vukem-video_<version>_linux_<arch>.deb`
  - any Linux: `vukem-video_<version>_linux_amd64.AppImage`
  - macOS: `vukem-video_<version>_darwin_<arch>.pkg`
- archives for six targets and `checksums.txt`, signed with cosign.

The container image of the web version is started with a command of this shape, which publishes the port on your computer only:

```bash
docker run --rm -p 127.0.0.1:7878:7878 -v vukem-video:/data \
  -e APP_KEY="$(openssl rand -base64 32)" \
  ghcr.io/alexgalhardo/vukem-video:<version>
```

The server listens on `127.0.0.1:7878` and is reachable from your computer only. Open that address in a browser to reach the editor. Your projects and media stay in the `vukem-video` volume, so a new container with the same volume finds them again. The [installation page](/docs/installation) has the details of the image and its tags.

### Windows SmartScreen and macOS Gatekeeper

The installers are not signed with a paid code-signing certificate, so both systems warn before the first run.

- **Windows.** SmartScreen shows "Windows protected your PC" for the `.exe`. Choose "More info", then "Run anyway".
- **macOS.** Gatekeeper says the package cannot be opened because Apple cannot check it. Control-click the `.pkg` and choose Open, or allow it in System Settings, Privacy & Security.

To check a download before you run it, verify `checksums.txt` with cosign and compare the SHA-256 of the file, as described in the [security policy](https://github.com/AlexGalhardo/vukem-video/blob/main/.github/SECURITY.md).

## For a person

1. Start the server (`vukem-video serve`).
2. Open `http://127.0.0.1:7878` in a browser, or run `vukem-video open`.

## For an agent

Pick one of three routes to the same project:

1. The stdio MCP server: the command is `vukem-video mcp`.
2. The CLI with `--json`, for example `vukem-video project:create --name "Launch teaser" --json`.
3. The HTTP API of `vukem-video serve`, with Streamable HTTP MCP at `POST /mcp`.

These routes share one set of operations, so an agent and a person see the same result. The [agents overview](/docs/agents/overview) shows how to connect one.

## Next steps

Back to the [introduction](/docs/introduction).
