getcompanion-ai/computer-host
1
0
Fork 0
mirror of https://github.com/getcompanion-ai/computer-host.git synced 2026-04-15 03:00:42 +00:00
Code Issues 6 Projects Releases Packages Wiki Activity Actions

chore: update readme

Browse source
This commit is contained in:
Harivansh Rathi 2026-04-09 03:07:33 +00:00
parent 25b9f74553
commit 791268fb33
1 changed files with 3 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

13
README.md
View file

@ -13,11 +13,9 @@ devices and nftables rules for networking, handles SSH key generation,
guest identity injection, and disk snapshots - all as atomic operations guest identity injection, and disk snapshots - all as atomic operations
behind a single host-level contract. behind a single host-level contract.
## API ### API
All endpoints accept and return JSON over a Unix socket. All endpoints accept and return JSON over Unix socket.
### Machines
``` ```
GET /health health check GET /health health check
@ -26,11 +24,6 @@ GET /machines list all machines
GET /machines/{id} get machine by id GET /machines/{id} get machine by id
DELETE /machines/{id} delete a machine DELETE /machines/{id} delete a machine
POST /machines/{id}/stop stop a running machine POST /machines/{id}/stop stop a running machine
```
### Snapshots
```
POST /machines/{id}/snapshots snapshot a running machine POST /machines/{id}/snapshots snapshot a running machine
GET /machines/{id}/snapshots list snapshots for a machine GET /machines/{id}/snapshots list snapshots for a machine
GET /snapshots/{id} get snapshot by id GET /snapshots/{id} get snapshot by id
@ -38,7 +31,7 @@ DELETE /snapshots/{id} delete a snapshot
POST /snapshots/{id}/restore restore snapshot to a new machine POST /snapshots/{id}/restore restore snapshot to a new machine
``` ```
## Running ### Running
Requires a Linux host with KVM, Firecracker, and jailer installed. Requires a Linux host with KVM, Firecracker, and jailer installed.