kept

<p align="center"> <picture> <source media="(prefers-color-scheme: dark)" srcset="docs/assets/kept-lockup-dark.svg"> <img src="docs/assets/kept-lockup-light.svg" alt="Kept" width="240"> </picture> </p> <p align="center"> A self-hosted, open-source inventory of everything you own and where it is,<br> with its paperwork and its history. </p> <!-- One style for every badge: flat-square, the kit's ink-2 (#55524C) label and amber (#F0B03A) value (apps/web/src/styles/tokens.css). Release and CI are live (shields.io reads GitHub): CI turns red when the ci workflow fails on main. Both read public data, so they render once the repository is public. --> <p align="center"> <a href="https://github.com/keptinventory/kept/releases/latest"><img alt="Latest release" src="https://img.shields.io/github/v/release/keptinventory/kept?sort=semver&display_name=tag&style=flat-square&label=release&labelColor=55524C&color=F0B03A"></a> <a href="https://github.com/keptinventory/kept/actions/workflows/ci.yml"><img alt="CI status" src="https://img.shields.io/github/actions/workflow/status/keptinventory/kept/ci.yml?branch=main&style=flat-square&label=ci&labelColor=55524C"></a> <a href="LICENSE"><img alt="Licence: AGPL-3.0" src="https://img.shields.io/badge/licence-AGPL--3.0-F0B03A?style=flat-square&labelColor=55524C"></a> <a href="https://keptinventory.info/"><img alt="Documentation" src="https://img.shields.io/badge/docs-keptinventory.info-F0B03A?style=flat-square&labelColor=55524C&label=docs"></a> <a href="https://github.com/orgs/keptinventory/packages/container/package/kept"><img alt="Container image: ghcr.io/keptinventory/kept" src="https://img.shields.io/badge/image-ghcr.io%2Fkeptinventory%2Fkept-F0B03A?style=flat-square&labelColor=55524C"></a> <a href="CONTRIBUTING.md#sign-the-cla-once-and-sign-off-every-commit"><img alt="CLA and DCO sign-off" src="https://img.shields.io/badge/CLA%20%2B%20DCO-sign--off-F0B03A?style=flat-square&labelColor=55524C"></a> </p> <p align="center"> <picture> <source media="(prefers-color-scheme: dark)" srcset="docs/assets/kept-hero-dark.webp"> <img src="docs/assets/kept-hero-light.webp" alt="Kept's home screen on a desktop, with the same screen on a phone in front: what needs you, the get-started checklist and recent activity"> </picture> </p> Kept tracks your homes, garages and storage units, the rooms, shelves and boxes inside them, and the things inside those, with their receipts, manuals, warranties and history. It runs on your own machine, and nothing leaves it unless you turn it on: no telemetry, the update check is off by default, and the AI provider is yours to choose. ## The location map Each location as a 3D map: floors, rooms, shelves and boxes, with what's inside one tap away. Arrange it yourself, or let Kept lay it out. Plan view, balconies and terraces, and phones included. <p align="center"> <img src="docs/assets/kept-map-light.webp" alt="A home on Kept's location map: rooms in 3D, a TV unit selected with its card open" width="720"> <img src="docs/assets/kept-map-phone-light.webp" alt="The location map on a phone, with a thing's card at the bottom" width="200"> </p> ## What it does - **Inventory.** Locations, places, boxes and things, with photos, documents, tags, custom fields, quantities, saved views, search and a trash you can restore from. - **Capture.** Photograph a thing, a receipt or a label, online or offline; your AI provider (OpenAI, Anthropic, Google, OpenRouter, Groq, or an OpenAI-compatible server such as Ollama) suggests the details and you confirm them. Without one, you type them. - **Labels.** Print label sheets with a short ID and a QR code; scan one to open the box it is on. - **The household.** Shared locations with roles, lending, schedules, warranties, paperwork and an insurance report; reminders in the app, by mail, by push and in a calendar feed. - **Vehicles and machines.** Readings, services, fuel and running costs. - **AI assistant and MCP server.** Ask in plain words; changes wait for your OK. Claude and other AI agents connect at `/mcp` ([how](https://keptinventory.info/users/mcp-clients/)). - **Backups you can read.** Nightly restic backups to a directory, S3 or SFTP, each with a copy that opens in a browser without Kept; imports from Homebox and CSV, full exports. - **Five languages:** English, Arabic (right to left), French, German and Italian. Installs on a phone as an app. <p align="center"> <img src="docs/assets/claude-mcp.webp" alt="Claude Code connected to Kept over MCP: asked to add a TV with its serial number, it puts it in Home › Living room" width="720"> </p> ## Quick start Docker with Compose v2: ```sh git clone --branch v1.7.1 --depth 1 https://github.com/keptinventory/kept.git && cd kept cp compose.env.example .env for v in SUPERUSER OWNER APP AUTH SYSTEM; do sed -i.bak "s/^KEPT_DB_${v}_PASSWORD=\$/KEPT_DB_${v}_PASSWORD=$(openssl rand -hex 32)/" .env done sed -i.bak 's|^KEPT_IMAGE=$|KEPT_IMAGE=ghcr.io/keptinventory/kept:1.7.1|' .env && rm .env.bak # Set KEPT_PUBLIC_URL in .env to the address you will open, e.g. http://<this host>:8080 docker compose up -d docker compose logs kept | grep "KEPT SETUP CODE" ``` Open `KEPT_PUBLIC_URL`, enter the setup code and create the first account: it becomes the instance admin. The camera, installing the app, push and location need HTTPS: `docker compose --profile https up -d` adds Caddy with a certificate for `KEPT_DOMAIN`. The [install guide](https://keptinventory.info/install/compose/) covers each step and keeping the keys; [verify the image's signature](https://keptinventory.info/admin/verify-release/) before you run it. ## Links | | | |---|---| | Documentation | [keptinventory.info](https://keptinventory.info/) | | Install | [Docker Compose](https://keptinventory.info/install/compose/), [HTTPS](https://keptinventory.info/install/https/), [Kubernetes](https://keptinventory.info/install/kubernetes/) (Helm chart in [`charts/kept`](charts/kept/)), [configuration](https://keptinventory.info/reference/configuration/) | | API | [HTTP API reference](https://keptinventory.info/api/), generated from the OpenAPI document | | MCP | [Connect an AI client](https://keptinventory.info/users/mcp-clients/) | | Contributing | [CONTRIBUTING.md](CONTRIBUTING.md) | | Security | [SECURITY.md](SECURITY.md): report privately, never in a public issue | | Changelog | [CHANGELOG.md](CHANGELOG.md) | ## Licence Kept is free software under the GNU Affero General Public License, version 3 ([`LICENSE`](LICENSE)), and every feature ships in it: nothing is held back. If you run a modified Kept for other people, you must offer them its source. The image carries the third-party notices of everything inside it, served at `/notices.txt`.