# Lorx

> Lorx is a git host with fast CI and change requests. bit is its command line: it runs a repository's CI locally with the engine Lorx uses, and opens, reads and merges change requests. Repositories are plain git at https://git.lorx.space/<owner>/<repo>.git, and the HTTP API is at https://git.lorx.space/api/v1 (OpenAPI: https://git.lorx.space/api/v1/openapi.json).

An agent skill for working on Lorx: https://lorx.space/skills/lorx/SKILL.md

## Get started

- [Install bit and set up your machine](https://lorx.space/docs/get-started/install.md): Install the bit command line, check git and your commit identity, and sign in to Lorx.
- [Create a repository and push](https://lorx.space/docs/get-started/first-repository.md): Make a repository on Lorx from your terminal or the web, push your code, and clone it elsewhere.
- [Move from GitHub](https://lorx.space/docs/get-started/move-from-github.md): Bring a repository's history, branches and tags to Lorx, and its pull requests with their comments and reviews.
- [Connect over HTTPS or SSH](https://lorx.space/docs/get-started/connect.md): Push and pull with git over HTTPS with a token, or over SSH with a key.

## CI

- [Workflow files](https://lorx.space/docs/ci/workflows.md): The format of .lorx/actions/*.yml, every key a job takes, and what each does.
- [Run CI on your machine](https://lorx.space/docs/ci/run-locally.md): bit run runs your workflows with the same engine Lorx uses, skipping steps that already passed.
- [CI runs on Lorx](https://lorx.space/docs/ci/runs-on-lorx.md): What a push runs, how jobs reach runners, and how to follow, cancel and rerun runs.
- [Runners](https://lorx.space/docs/ci/runners.md): Make any machine with bit a runner for your account or one repository, route jobs to it with labels, and drain or remove it.

## Change requests

- [Open and review change requests](https://lorx.space/docs/change-requests/open-and-review.md): Propose a branch for merging, from the terminal or the web, and review it line by line.
- [Merge, auto-merge, conflicts and reverts](https://lorx.space/docs/change-requests/merge.md): Merge a change request three ways, let it merge itself when ready, fix conflicts in the browser, and take a merge back.
- [Branch rules](https://lorx.space/docs/change-requests/branch-rules.md): Protect branches so they change only through change requests, can't be force-pushed or deleted, and merge only when CI passes and the review finds nothing serious.

## bit

- [What bit is](https://lorx.space/docs/bit/overview.md): bit is git with Lorx built in: CI on your machine, change requests from your terminal, and sign-in for git.
- [bit command reference](https://lorx.space/docs/bit/reference.md): Every bit command and option, from bit's own help (bit 0.1.7).

## Account & security

- [Access tokens](https://lorx.space/docs/account/tokens.md): Personal access tokens for git over HTTPS, scripts, CI and agents, limited to what they need.
- [SSH and signing keys](https://lorx.space/docs/account/ssh-keys.md): Add SSH keys to push and pull over SSH, and to sign your commits.
- [Security and your account log](https://lorx.space/docs/account/security.md): How Lorx confirms risky actions, and where to see what happened on your account.

## API

- [API](https://lorx.space/docs/api/overview.md): Lorx's HTTP API: where it is, how to authenticate, errors, paging, and the OpenAPI document.

## Agents

- [Lorx for agents](https://lorx.space/docs/agents/overview.md): Give coding agents what they need to use Lorx: a skill, plain-text docs, and commands with JSON output.