# Project pack: ConvertX @ 2135c6b

Facts about **ConvertX** for an AI following the [BespokeAI handover guide](https://handoff.bespokeai.software/guide/v4.md). Pinned to one version; never changes after publication.

> ConvertX is a small self-hosted file converter. You upload a file, choose the output format, and it uses well-known tools such as FFmpeg, ImageMagick and Pandoc behind the scenes. It handles over a thousand formats and keeps a history of conversions on your own server.

## Setup path (checked 2026-11-03)
- **Needs Docker.** Tell the person before any setup work; no light non-Docker route is documented upstream. Docker Desktop on Windows may need a computer restart and an admin-only Windows feature (virtualisation); say so and let the person decide.
- Verdict source: https://raw.githubusercontent.com/C4illin/ConvertX/HEAD/README.md
- You may be unable to download source archives or run commands in this session. The person downloads and runs things; if you cannot fetch something, give any changed file in full in chat with its path.

## Version and source
- Repository: https://github.com/C4illin/ConvertX
- Pinned commit: `2135c6b9f1bed5c4fdf9d2b1cfb7cdf54e9e2bad`. Use exactly this version.
- Zip the person can download in a browser: https://github.com/C4illin/ConvertX/archive/2135c6b9f1bed5c4fdf9d2b1cfb7cdf54e9e2bad.zip
- Fresh checkout (only if you have a shell and git): use the commands below in an empty folder. If this exact source is already checked out, keep your branch and use the development command; do not clone again or reset local changes.
- Licence: **AGPL-3.0-only**. Free to use and change. If other people use your changed version, including over a network (for example a website you host for them), you must offer them your source code under the same licence. Using it privately for yourself or your household has no extra obligations.

## Commands from the pinned source
- Developer commands (they may use Docker):

  ```sh
  git clone https://github.com/C4illin/ConvertX bespoke-convertx
  cd bespoke-convertx
  git checkout --detach 2135c6b9f1bed5c4fdf9d2b1cfb7cdf54e9e2bad
  # Prepare development requirements and local configuration first.
  bun install
  bun run dev
  ```

- Separate trial of the current upstream release (not your changes; sample data and a separate data directory only):

  ```sh
  docker run -d --name convertx -p 3000:3000 -e JWT_SECRET=replace-with-a-long-random-string -e HTTP_ALLOWED=true -v convertx-data:/app/data ghcr.io/c4illin/convertx
  # then open http://localhost:3000 and create the first account
  ```
- Tools these commands use: Docker for a trial, Bun for development
- Develop: `bun run dev`
- Test: `bun test`
- Check/lint: `bun run lint`
- Stack: typescript (Bun, Elysia, HTMX, Tailwind). Difficulty for a non-developer with an AI: **easy**. A compact Bun app that wraps command-line converters. Adding a converter means a small TypeScript module that builds a command and lists the formats it supports.
Personal data: **yes**. Stored in: A SQLite database and uploaded and converted files in /app/data. Secrets are entered by the person, never in chat.

---
Later, only when a step needs it: [reference.md](https://handoff.bespokeai.software/p/convertx/2135c6b/r3/reference.md) (customisation points, must-keep-working, data and costs, coding conventions) · [hosting.md](https://handoff.bespokeai.software/p/convertx/2135c6b/r3/hosting.md) (long-term hosting; hosts are paid third parties) · [bespoke.yaml](https://handoff.bespokeai.software/p/convertx/2135c6b/r3/bespoke.yaml) · [SKILL.md](https://handoff.bespokeai.software/p/convertx/2135c6b/r3/SKILL.md)