Skip to content

Commit 9440bfd

Browse files
committed
Rename CLI and docs from VectraCtl to SynCtl/Synentra
Updated README.md to reflect the rebranding from VectraCtl/Vectra to SynCtl/Synentra. Changed all references, commands, configuration paths, Docker image names, project structure, and license attribution to use the new names and repository URLs. All usage examples and build instructions now reference SynCtl/Synentra. #55
1 parent 7b48f28 commit 9440bfd

1 file changed

Lines changed: 74 additions & 74 deletions

File tree

‎README.md‎

Lines changed: 74 additions & 74 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
<div align="center">
22

3-
# VectraCtl
3+
# SynCtl
44

5-
**The official CLI for [Vectra](https://github.com/cortexiumlabs/vectra) — Intent-Aware Governance Gateway for Autonomous AI Agents**
5+
**The official CLI for [Synentra](https://github.com/synentra/synctl) — Intent-Aware Governance Gateway for Autonomous AI Agents**
66

77
[![.NET](https://img.shields.io/badge/.NET-10-512BD4?logo=dotnet)](https://dotnet.microsoft.com)
88
[![License: Apache-2.0](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](LICENSE)
9-
[![GitHub release](https://img.shields.io/github/v/release/cortexiumlabs/vectractl)](https://github.com/cortexiumlabs/vectractl/releases)
9+
[![GitHub release](https://img.shields.io/github/v/release/synentra/synctl)](https://github.com/synentra/synctl/releases)
1010

11-
`vectractl` gives you full command-line control over the Vectra gateway: install, run, and update the gateway engine; register and manage AI agents; define governance policies; review and resolve Human-in-the-Loop (HITL) approvals; and exchange agent credentials for JWT bearer tokens — all from your terminal.
11+
`synctl` gives you full command-line control over the Synentra gateway: install, run, and update the gateway engine; register and manage AI agents; define governance policies; review and resolve Human-in-the-Loop (HITL) approvals; and exchange agent credentials for JWT bearer tokens — all from your terminal.
1212

1313
</div>
1414

@@ -37,9 +37,9 @@
3737

3838
## Overview
3939

40-
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.
40+
Synentra 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.
4141

42-
`vectractl` is the companion CLI that lets platform engineers, DevOps teams, and AI developers interact with the gateway from the terminal or from CI/CD pipelines.
42+
`synctl` is the companion CLI that lets platform engineers, DevOps teams, and AI developers interact with the gateway from the terminal or from CI/CD pipelines.
4343

4444
## Prerequisites
4545

@@ -54,63 +54,63 @@ Docker is only required when using the `--docker` deployment mode.
5454

5555
### Option 1 – Download a pre-built binary (recommended)
5656

57-
Pre-built binaries for Windows, macOS, and Linux are available on the [Releases](https://github.com/cortexiumlabs/vectractl/releases) page.
57+
Pre-built binaries for Windows, macOS, and Linux are available on the [Releases](https://github.com/synentra/synctl/releases) page.
5858

5959
```bash
6060
# Example: Linux / macOS
61-
curl -sSL https://github.com/cortexiumlabs/vectractl/releases/latest/download/vectractl-linux-x64.tar.gz | tar xz
62-
sudo mv vectractl /usr/local/bin/
61+
curl -sSL https://github.com/synentra/synctl/releases/latest/download/synctl-linux-x64.tar.gz | tar xz
62+
sudo mv synctl /usr/local/bin/
6363
```
6464

6565
### Option 2 – Build from source
6666

6767
```bash
68-
git clone https://github.com/cortexiumlabs/vectractl.git
69-
cd vectractl
70-
dotnet publish src/VectraCtl/VectraCtl.csproj -c Release -o ./publish
68+
git clone https://github.com/synentra/synctl.git
69+
cd synctl
70+
dotnet publish src/SynCtl/SynCtl.csproj -c Release -o ./publish
7171
# Add ./publish to your PATH
7272
```
7373

7474
## Quick Start
7575

7676
```bash
77-
# 1. Install and start the Vectra gateway (local binary)
78-
vectractl init
79-
vectractl run
77+
# 1. Install and start the Synentra gateway (local binary)
78+
synctl init
79+
synctl run
8080

8181
# --- or, using Docker ---
82-
vectractl init --docker --port 7080 --mount /data/vectra
83-
vectractl run --docker
82+
synctl init --docker --port 7080 --mount /data/synentra
83+
synctl run --docker
8484

8585
# 2. Register an AI agent
86-
vectractl agents register --name "my-agent" --owner "platform-team" --secret "s3cr3t"
86+
synctl agents register --name "my-agent" --owner "platform-team" --secret "s3cr3t"
8787

8888
# 3. Assign a governance policy to the agent
89-
vectractl agents assign-policy --agent-id <GUID> --policy "strict-pii"
89+
synctl agents assign-policy --agent-id <GUID> --policy "strict-pii"
9090

9191
# 4. Obtain a JWT bearer token for the agent
92-
vectractl token --agent-id <GUID> --secret "s3cr3t"
92+
synctl token --agent-id <GUID> --secret "s3cr3t"
9393

9494
# 5. Review pending Human-in-the-Loop approval requests
95-
vectractl hitl list
96-
vectractl hitl approve --id <REQUEST-ID> --comment "Reviewed and approved"
95+
synctl hitl list
96+
synctl hitl approve --id <REQUEST-ID> --comment "Reviewed and approved"
9797
```
9898

9999
## Commands
100100

101101
### `init`
102102

103-
Downloads and installs the Vectra gateway engine locally or pulls the Docker image.
103+
Downloads and installs the Synentra gateway engine locally or pulls the Docker image.
104104

105105
```
106-
vectractl init [OPTIONS]
106+
synctl init [OPTIONS]
107107
```
108108

109109
| Option | Description | Default |
110110
|---|---|---|
111111
| `--docker` | Pull and configure the Docker image instead of a local binary | `false` |
112112
| `--version <ver>` | Specific gateway version to install (e.g. `1.2.3`) | latest |
113-
| `--container-name <name>` | Docker container name | `vectra-gateway` |
113+
| `--container-name <name>` | Docker container name | `synentra-gateway` |
114114
| `--port <port>` | Host port mapped to the container | `7080` |
115115
| `--mount <path>` | Host path to mount as the container data directory | — |
116116
| `--container-path <path>` | Container-internal data path | `/app/data` |
@@ -119,21 +119,21 @@ vectractl init [OPTIONS]
119119

120120
```bash
121121
# Install the latest binary release
122-
vectractl init
122+
synctl init
123123

124124
# Install a specific version
125-
vectractl init --version 1.5.0
125+
synctl init --version 1.5.0
126126

127127
# Pull and configure a Docker deployment
128-
vectractl init --docker --port 7080 --mount ~/vectra-data
128+
synctl init --docker --port 7080 --mount ~/synentra-data
129129
```
130130

131131
### `run`
132132

133-
Starts the Vectra gateway (binary or Docker container).
133+
Starts the Synentra gateway (binary or Docker container).
134134

135135
```
136-
vectractl run [OPTIONS]
136+
synctl run [OPTIONS]
137137
```
138138

139139
| Option | Description | Default |
@@ -144,35 +144,35 @@ vectractl run [OPTIONS]
144144
**Examples**
145145

146146
```bash
147-
vectractl run # start local binary (foreground)
148-
vectractl run --background # start local binary (background)
149-
vectractl run --docker # start Docker container (foreground)
150-
vectractl run --docker --background # start Docker container (detached)
147+
synctl run # start local binary (foreground)
148+
synctl run --background # start local binary (background)
149+
synctl run --docker # start Docker container (foreground)
150+
synctl run --docker --background # start Docker container (detached)
151151
```
152152

153153
### `stop`
154154

155-
Stops the running Vectra gateway.
155+
Stops the running Synentra gateway.
156156

157157
```
158-
vectractl stop [OPTIONS]
158+
synctl stop [OPTIONS]
159159
```
160160

161161
| Option | Description |
162162
|---|---|
163163
| `--docker` | Stop the Docker container instead of the local binary process |
164164

165165
```bash
166-
vectractl stop
167-
vectractl stop --docker
166+
synctl stop
167+
synctl stop --docker
168168
```
169169

170170
### `update`
171171

172-
Updates the Vectra gateway binary to a newer (or specific) version.
172+
Updates the Synentra gateway binary to a newer (or specific) version.
173173

174174
```
175-
vectractl update [OPTIONS]
175+
synctl update [OPTIONS]
176176
```
177177

178178
| Option | Description | Default |
@@ -181,17 +181,17 @@ vectractl update [OPTIONS]
181181
| `--force` | Stop the running gateway automatically before updating | `false` |
182182

183183
```bash
184-
vectractl update # update to latest
185-
vectractl update --version 2.0.0 # update to a specific version
186-
vectractl update --force # stop gateway automatically, then update
184+
synctl update # update to latest
185+
synctl update --version 2.0.0 # update to a specific version
186+
synctl update --force # stop gateway automatically, then update
187187
```
188188

189189
### `uninstall`
190190

191-
Removes the Vectra gateway engine (binary or Docker).
191+
Removes the Synentra gateway engine (binary or Docker).
192192

193193
```
194-
vectractl uninstall [OPTIONS]
194+
synctl uninstall [OPTIONS]
195195
```
196196

197197
| Option | Description |
@@ -201,25 +201,25 @@ vectractl uninstall [OPTIONS]
201201
| `--remove-data` | Also delete the engine data directory *(Docker mode only)* |
202202

203203
```bash
204-
vectractl uninstall
205-
vectractl uninstall --docker --remove-data
206-
vectractl uninstall --force
204+
synctl uninstall
205+
synctl uninstall --docker --remove-data
206+
synctl uninstall --force
207207
```
208208

209209
### `agents`
210210

211-
Manage AI agents registered in the Vectra gateway.
211+
Manage AI agents registered in the Synentra gateway.
212212

213213
#### `agents list`
214214

215215
```bash
216-
vectractl agents list [--page <n>] [--page-size <n>] [-o json|table]
216+
synctl agents list [--page <n>] [--page-size <n>] [-o json|table]
217217
```
218218

219219
#### `agents register`
220220

221221
```bash
222-
vectractl agents register --name <name> --owner <owner> --secret <secret>
222+
synctl agents register --name <name> --owner <owner> --secret <secret>
223223
```
224224

225225
| Option | Description | Required |
@@ -231,7 +231,7 @@ vectractl agents register --name <name> --owner <owner> --secret <secret>
231231
#### `agents assign-policy`
232232

233233
```bash
234-
vectractl agents assign-policy --agent-id <GUID> --policy <policy-name>
234+
synctl agents assign-policy --agent-id <GUID> --policy <policy-name>
235235
```
236236

237237
| Option | Description | Required |
@@ -242,23 +242,23 @@ vectractl agents assign-policy --agent-id <GUID> --policy <policy-name>
242242
#### `agents delete`
243243

244244
```bash
245-
vectractl agents delete --agent-id <GUID>
245+
synctl agents delete --agent-id <GUID>
246246
```
247247

248248
### `policies`
249249

250-
Browse governance policies defined in the Vectra gateway.
250+
Browse governance policies defined in the Synentra gateway.
251251

252252
#### `policies list`
253253

254254
```bash
255-
vectractl policies list [--page <n>] [--page-size <n>] [-o json|table]
255+
synctl policies list [--page <n>] [--page-size <n>] [-o json|table]
256256
```
257257

258258
#### `policies details`
259259

260260
```bash
261-
vectractl policies details --name <policy-name> [-o json|table]
261+
synctl policies details --name <policy-name> [-o json|table]
262262
```
263263

264264
### `hitl`
@@ -268,33 +268,33 @@ Manage Human-in-the-Loop review requests generated by the gateway when an agent
268268
#### `hitl list`
269269

270270
```bash
271-
vectractl hitl list [--page <n>] [--page-size <n>] [-o json|table]
271+
synctl hitl list [--page <n>] [--page-size <n>] [-o json|table]
272272
```
273273

274274
#### `hitl status`
275275

276276
```bash
277-
vectractl hitl status --id <request-id> [-o json|table]
277+
synctl hitl status --id <request-id> [-o json|table]
278278
```
279279

280280
#### `hitl approve`
281281

282282
```bash
283-
vectractl hitl approve --id <request-id> [--comment "Approved"]
283+
synctl hitl approve --id <request-id> [--comment "Approved"]
284284
```
285285

286286
#### `hitl deny`
287287

288288
```bash
289-
vectractl hitl deny --id <request-id> [--comment "Rejected: policy violation"]
289+
synctl hitl deny --id <request-id> [--comment "Rejected: policy violation"]
290290
```
291291

292292
### `token`
293293

294-
Exchange agent credentials for a short-lived JWT bearer token that can be used to authenticate API calls to the Vectra gateway.
294+
Exchange agent credentials for a short-lived JWT bearer token that can be used to authenticate API calls to the Synentra gateway.
295295

296296
```
297-
vectractl token --agent-id <GUID> --secret <secret> [-o json|table]
297+
synctl token --agent-id <GUID> --secret <secret> [-o json|table]
298298
```
299299

300300
| Option | Description | Required |
@@ -304,7 +304,7 @@ vectractl token --agent-id <GUID> --secret <secret> [-o json|table]
304304
| `-o, --output` | Output format (`json` \| `table`) | — |
305305

306306
```bash
307-
vectractl token --agent-id 3fa85f64-5717-4562-b3fc-2c963f66afa6 --secret "s3cr3t"
307+
synctl token --agent-id 3fa85f64-5717-4562-b3fc-2c963f66afa6 --secret "s3cr3t"
308308
```
309309

310310
## Global Options
@@ -319,7 +319,7 @@ These options are available on all list-style subcommands:
319319

320320
## Configuration
321321

322-
`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.
322+
`synctl` stores its runtime configuration in `~/.synentra/appsettings.json`. This file is created automatically when you run `synctl init` and is updated by subsequent commands.
323323

324324
```jsonc
325325
{
@@ -328,35 +328,35 @@ These options are available on all list-style subcommands:
328328
"Version": "1.5.0"
329329
},
330330
"Docker": {
331-
"ImageName": "cortexiumlabs/vectra",
331+
"ImageName": "synentra/synentra",
332332
"Tag": "1.5.0",
333-
"ContainerName": "vectra-gateway",
333+
"ContainerName": "synentra-gateway",
334334
"Port": 7080,
335-
"HostDataPath": "/home/user/vectra-data",
335+
"HostDataPath": "/home/user/synentra-data",
336336
"ContainerDataPath": "/app/data"
337337
}
338338
}
339339
```
340340

341-
You can edit this file manually or use `vectractl init` to regenerate it.
341+
You can edit this file manually or use `synctl init` to regenerate it.
342342

343343
## Project Structure
344344

345345
```
346-
vectractl/
346+
synctl/
347347
├── src/
348-
│ ├── VectraCtl/ # CLI entry point & command definitions
348+
│ ├── SynentraCtl/ # CLI entry point & command definitions
349349
│ │ ├── Commands/ # One file per top-level command
350350
│ │ ├── ApplicationBuilders/ # CLI application wiring (DI, System.CommandLine)
351351
│ │ ├── Services/ # Location, versioning, Spectre.Console logger
352352
│ │ └── Program.cs
353353
│ │
354-
│ ├── VectraCtl.Core/ # Abstractions & domain models (no external deps)
354+
│ ├── SynentraCtl.Core/ # Abstractions & domain models (no external deps)
355355
│ │ ├── Models/ # AppSettings, DockerRunOptions, etc.
356356
│ │ ├── Services/ # Service interfaces (Docker, GitHub, Config, …)
357357
│ │ └── Serialization/ # JSON serializer interfaces
358358
│ │
359-
│ └── VectraCtl.Infrastructure/ # Concrete implementations
359+
│ └── SynentraCtl.Infrastructure/ # Concrete implementations
360360
│ ├── Services/ # Docker, GitHub release manager, process handler
361361
│ └── Serialization/ # System.Text.Json implementation
362362
└── README.md
@@ -372,7 +372,7 @@ dotnet restore
372372
dotnet build
373373

374374
# Build self-contained binary for your platform
375-
dotnet publish src/VectraCtl/VectraCtl.csproj \
375+
dotnet publish src/SynentraCtl/SynentraCtl.csproj \
376376
-c Release \
377377
-r linux-x64 \
378378
--self-contained true \
@@ -397,4 +397,4 @@ Please keep PRs focused on a single concern. For large changes, open an issue fi
397397

398398
## License
399399

400-
© Cortexium Labs. Licensed under the [Apache License, Version 2.0](LICENSE).
400+
© Synentra. Licensed under the [Apache License, Version 2.0](LICENSE).

0 commit comments

Comments
 (0)