Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 53 additions & 0 deletions go/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
# Go client for microinit

IPC client library for the microinit control socket (length-prefixed JSON over Unix domain sockets).

## Import

```go
import "github.com/dcc-bigfred/microinit/go/client"

c := &client.Client{Socket: client.DefaultSocket} // or override
list, err := c.List()
```

## Module path / versioning

```
module github.com/dcc-bigfred/microinit/go
```

Tag Go releases as **`go/vX.Y.Z`** (required because the module path ends with `/go`), for example:

```bash
git tag go/v0.1.0
git push origin go/v0.1.0
```

Then consumers:

```bash
go get github.com/dcc-bigfred/microinit/go@go/v0.1.0
```

For local monorepo development:

```go
// go.mod
replace github.com/dcc-bigfred/microinit/go => ../microinit/go
```

Private repos need `GOPRIVATE=github.com/dcc-bigfred/*`.

## API

| Method | Description |
|--------|-------------|
| `List()` | All services |
| `Status(name)` | One service |
| `Control(name, start\|stop\|restart)` | Lifecycle |
| `Shutdown()` | Halt supervise (caller-owned daemon) |
| `FollowLogs` / `ReadResponse` | Log stream |
| `ValidateName` / `FormatLogLine` | Helpers |

Default socket: `/data/run/microinit.sock` (`client.DefaultSocket`).
Loading
Loading