Skip to content

Commit d56ac04

Browse files
committed
Update README for clarity, consistency, and completeness
Revised command examples for consistency, clarified prerequisites and installation steps, expanded and standardized command documentation, refined project structure and build instructions, and improved contributing guidelines. Made minor formatting and language improvements throughout. #16
1 parent 8e1ef85 commit d56ac04

1 file changed

Lines changed: 0 additions & 40 deletions

File tree

‎README.md‎

Lines changed: 0 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,6 @@
1212

1313
</div>
1414

15-
---
16-
1715
## Table of Contents
1816

1917
- [Overview](#overview)
@@ -37,8 +35,6 @@
3735
- [Contributing](#contributing)
3836
- [License](#license)
3937

40-
---
41-
4238
## Overview
4339

4440
Vectra is an **Intent-Aware Governance Gateway** that sits between autonomous AI agents and the outside world. It enforces governance policies, routes actions through Human-in-the-Loop review when required, and provides a full audit trail.
@@ -52,8 +48,6 @@ AI Agent ──► Vectra Gateway ──► External Systems
5248
(manage, audit, approve)
5349
```
5450

55-
---
56-
5751
## Prerequisites
5852

5953
| Requirement | Minimum Version |
@@ -63,8 +57,6 @@ AI Agent ──► Vectra Gateway ──► External Systems
6357

6458
Docker is only required when using the `--docker` deployment mode.
6559

66-
---
67-
6860
## Installation
6961

7062
### Option 1 – Download a pre-built binary (recommended)
@@ -86,8 +78,6 @@ dotnet publish src/VectraCtl/VectraCtl.csproj -c Release -o ./publish
8678
# Add ./publish to your PATH
8779
```
8880

89-
---
90-
9181
## Quick Start
9282

9383
```bash
@@ -113,8 +103,6 @@ vectractl hitl list
113103
vectractl hitl approve --id <REQUEST-ID> --comment "Reviewed and approved"
114104
```
115105

116-
---
117-
118106
## Commands
119107

120108
### `init`
@@ -147,8 +135,6 @@ vectractl init --version 1.5.0
147135
vectractl init --docker --port 7080 --mount ~/vectra-data
148136
```
149137

150-
---
151-
152138
### `run`
153139

154140
Starts the Vectra gateway (binary or Docker container).
@@ -171,8 +157,6 @@ vectractl run --docker # start Docker container (foreground)
171157
vectractl run --docker --background # start Docker container (detached)
172158
```
173159

174-
---
175-
176160
### `stop`
177161

178162
Stops the running Vectra gateway.
@@ -190,8 +174,6 @@ vectractl stop
190174
vectractl stop --docker
191175
```
192176

193-
---
194-
195177
### `update`
196178

197179
Updates the Vectra gateway binary to a newer (or specific) version.
@@ -211,8 +193,6 @@ vectractl update --version 2.0.0 # update to a specific version
211193
vectractl update --force # stop gateway automatically, then update
212194
```
213195

214-
---
215-
216196
### `uninstall`
217197

218198
Removes the Vectra gateway engine (binary or Docker).
@@ -233,8 +213,6 @@ vectractl uninstall --docker --remove-data
233213
vectractl uninstall --force
234214
```
235215

236-
---
237-
238216
### `agents`
239217

240218
Manage AI agents registered in the Vectra gateway.
@@ -274,8 +252,6 @@ vectractl agents assign-policy --agent-id <GUID> --policy <policy-name>
274252
vectractl agents delete --agent-id <GUID>
275253
```
276254

277-
---
278-
279255
### `policies`
280256

281257
Browse governance policies defined in the Vectra gateway.
@@ -292,8 +268,6 @@ vectractl policies list [--page <n>] [--page-size <n>] [-o json|table]
292268
vectractl policies details --name <policy-name> [-o json|table]
293269
```
294270

295-
---
296-
297271
### `hitl`
298272

299273
Manage Human-in-the-Loop review requests generated by the gateway when an agent action requires human approval.
@@ -322,8 +296,6 @@ vectractl hitl approve --id <request-id> [--comment "Approved"]
322296
vectractl hitl deny --id <request-id> [--comment "Rejected: policy violation"]
323297
```
324298

325-
---
326-
327299
### `token`
328300

329301
Exchange agent credentials for a short-lived JWT bearer token that can be used to authenticate API calls to the Vectra gateway.
@@ -342,8 +314,6 @@ vectractl token --agent-id <GUID> --secret <secret> [-o json|table]
342314
vectractl token --agent-id 3fa85f64-5717-4562-b3fc-2c963f66afa6 --secret "s3cr3t"
343315
```
344316

345-
---
346-
347317
## Global Options
348318

349319
These options are available on all list-style subcommands:
@@ -354,8 +324,6 @@ These options are available on all list-style subcommands:
354324
| `--page-size <n>` | Number of results per page | `25` |
355325
| `-o, --output` | Output format: `json` or `table` | `json` |
356326

357-
---
358-
359327
## Configuration
360328

361329
`vectractl` stores its runtime configuration in `~/.vectra/appsettings.json`. This file is created automatically when you run `vectractl init` and is updated by subsequent commands.
@@ -379,8 +347,6 @@ These options are available on all list-style subcommands:
379347

380348
You can edit this file manually or use `vectractl init` to regenerate it.
381349

382-
---
383-
384350
## Project Structure
385351

386352
```
@@ -403,8 +369,6 @@ vectractl/
403369
└── README.md
404370
```
405371

406-
---
407-
408372
## Building from Source
409373

410374
```bash
@@ -427,8 +391,6 @@ dotnet test
427391

428392
Supported runtime identifiers: `win-x64`, `linux-x64`, `osx-x64`, `osx-arm64`.
429393

430-
---
431-
432394
## Contributing
433395

434396
Contributions are welcome! Please follow these steps:
@@ -440,8 +402,6 @@ Contributions are welcome! Please follow these steps:
440402

441403
Please keep PRs focused on a single concern. For large changes, open an issue first to discuss the approach.
442404

443-
---
444-
445405
## License
446406

447407
© Cortexium Labs. Licensed under the [Apache License, Version 2.0](LICENSE).

0 commit comments

Comments
 (0)