Skip to content

chore: fix audit violations — remove docs/gen, fix README, consolidate tests #34

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
retr0h merged 1 commit into from
Mar 29, 2026
Merged

chore: fix audit violations — remove docs/gen, fix README, consolidate tests #34

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
18 changes: 11 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,15 @@
[![conventional commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg?style=for-the-badge)](https://conventionalcommits.org)
[![built with just](https://img.shields.io/badge/Built_with-Just-black?style=for-the-badge&logo=just&logoColor=white)](https://just.systems)
![gitHub commit activity](https://img.shields.io/github/commit-activity/m/osapi-io/osapi-orchestrator?style=for-the-badge)
[![go reference](https://img.shields.io/badge/go-reference-00ADD8?style=for-the-badge&logo=go&logoColor=white)](https://pkg.go.dev/github.com/osapi-io/osapi-orchestrator/pkg/orchestrator)

# OSAPI Orchestrator

A Go package for orchestrating operations across [OSAPI][]-managed hosts --
typed operations, chaining, conditions, and result decoding built on top
of the [osapi-sdk][] engine.

## Install
## 📦 Install

```bash
go install github.com/osapi-io/osapi-orchestrator@latest
Expand All @@ -26,7 +27,7 @@ As a library dependency:
go get github.com/osapi-io/osapi-orchestrator
```

## Targeting
## 🎯 Targeting

Most operations accept a `target` parameter to control which agents receive
the request:
Expand All @@ -38,7 +39,7 @@ the request:
| `hostname` | Send to a specific host |
| `key:value` | Send to agents matching a label |

## Operations
## ⚙️ Operations

37 typed constructors across 8 domains:

Expand All @@ -53,15 +54,17 @@ the request:
| Agent | [4 operations](docs/operations/agent/) | [agent-drain.go](examples/operations/agent-drain.go) |
| Health | [1 operation](docs/operations/health/) | [basic.go](examples/features/basic.go) |

## Features
## ✨ Features

- [Feature Guides](docs/features/README.md) -- Step chaining, guards,
retry, broadcast, discovery, file workflows, host status awareness,
and result decoding
- [API Reference](docs/gen/orchestrator.md) -- Auto-generated Go
documentation

## Examples
## 📖 Documentation

See the [package documentation][] on pkg.go.dev for API details.

## 📋 Examples

Each example is a standalone Go file. Run with:

Expand Down Expand Up @@ -115,4 +118,5 @@ The [MIT][] License.

[OSAPI]: https://github.com/osapi-io/osapi
[osapi-sdk]: https://github.com/osapi-io/osapi/tree/main/pkg/sdk
[package documentation]: https://pkg.go.dev/github.com/osapi-io/osapi-orchestrator/pkg/orchestrator
[MIT]: LICENSE
Loading
Loading