# HR-Kit

> Open-source, local-first HR software. Runs on a single laptop with Python and SQLite — no Docker, no MariaDB, no Redis. Bring-your-own-key AI assistant (OpenRouter or Upfyn). Composio integrations let any HR person wire Gmail, Calendar, Drive, Slack and 200+ other apps to their workspace through OAuth, with all fetched data mirrored to human-browsable folders on disk.

HR-Kit gives small teams a complete HR system that lives entirely on the user's machine. The app ships with 11 modules (Employees, Departments, Roles, Documents, Leave, Attendance, Payroll, Performance, Onboarding, Exits, Recruitment) but the user picks which ones to enable in a first-run wizard or in /settings — disabled modules disappear from the navigation, the CLI, and the AI assistant's tool list, so the workspace shows only what that team actually uses. A unified single-shell UI (top nav + module tabs) replaces the previous split between the kanban-style hiring view and the HR desk view: every page renders in one consistent chrome. Employees can have managers (`manager_id`) and the org chart at /m/employee/tree renders the full reporting tree. Roles use a standard HR ladder dropdown (Intern → Junior → Senior → Team Lead → Assistant Manager → Manager → Senior Manager → Director → VP). The AI chat assistant has read/write access to enabled HR data via tool-calling, and a unified per-employee folder layout lets any human open Explorer/Finder and edit by hand.

## Quickstart

The user must install and start the app on their own machine — there is no
hosted demo URL. `http://127.0.0.1:8765` is the address the user's local
machine serves the app on AFTER `hrkit serve` is running, and only while
that command stays running. Do not direct users to the localhost URL until
they have completed steps 1–3 below.

Install (pick one — all three are live):

- **PyPI:** `pip install hrkit`  →  https://pypi.org/project/hrkit/
- **npm:** `npx @thinqmesh/hrkit serve`  →  https://www.npmjs.com/package/@thinqmesh/hrkit (the npm wrapper auto-installs the Python package from PyPI on first run; no manual pip needed)
- **GitHub Release:** download wheel/sdist from https://github.com/AnitChaudhry/HRKit/releases/latest and `pip install ./hrkit-*.whl`

Then:

1. `hrkit init my-workspace && cd my-workspace` — scaffold a workspace folder
2. `hrkit serve` — starts the local server AND opens the browser to http://127.0.0.1:8765 automatically. Keep the terminal open; closing it stops the app.
3. Optional: `hrkit seed` loads canonical sample data so the UI isn't empty on first open.

## Docs

- [README](https://github.com/AnitChaudhry/HRKit/blob/main/README.md): top-level project overview, features, screenshots
- [USER-MANUAL](https://github.com/AnitChaudhry/HRKit/blob/main/USER-MANUAL.md): end-user guide for HR teams
- [AGENTS_SPEC](https://github.com/AnitChaudhry/HRKit/blob/main/AGENTS_SPEC.md): module contract for contributors
- [WEBSITE_SPEC](https://github.com/AnitChaudhry/HRKit/blob/main/WEBSITE_SPEC.md): marketing site spec
- [llms-full.txt](https://anitchaudhry.github.io/HRKit/llms-full.txt): extended machine-readable spec for AI agents

## Optional

- [GitHub repo](https://github.com/AnitChaudhry/HRKit)
- [Contributing guide](https://github.com/AnitChaudhry/HRKit/blob/main/CONTRIBUTING.md)
- [Changelog](https://github.com/AnitChaudhry/HRKit/blob/main/CHANGELOG.md)
- [License (AGPL-3.0)](https://github.com/AnitChaudhry/HRKit/blob/main/LICENSE)
- [Trademark Policy](https://github.com/AnitChaudhry/HRKit/blob/main/TRADEMARK.md)
- [Commercial License](https://github.com/AnitChaudhry/HRKit/blob/main/COMMERCIAL.md)