@bpinhosilva/agent-orchestrator 1.0.0-alpha.23 → 1.0.0-alpha.25

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [1.0.0-alpha.25](https://github.com/bpinhosilva/agent-orchestrator/compare/v1.0.0-alpha.24...v1.0.0-alpha.25) (2026-04-03)
+
+
+### Features
+
+* **cli:** enhance setup command with detailed configuration options and improved process ([2b7f51d](https://github.com/bpinhosilva/agent-orchestrator/commit/2b7f51d16e8f1949e222c03968d925030e4b0574))
+
+# [1.0.0-alpha.24](https://github.com/bpinhosilva/agent-orchestrator/compare/v1.0.0-alpha.23...v1.0.0-alpha.24) (2026-04-02)
+
+
+### Features
+
+* update README and documentation files with additional references and streamlined content ([ae7b1ac](https://github.com/bpinhosilva/agent-orchestrator/commit/ae7b1acbd47eebbc91b154f2b54da83eb8da0be8))
+
 # [1.0.0-alpha.23](https://github.com/bpinhosilva/agent-orchestrator/compare/v1.0.0-alpha.22...v1.0.0-alpha.23) (2026-04-02)
 
 

package/README.md

@@ -24,21 +24,53 @@ Agent Orchestrator is an open-source project designed to manage and orchestrate
 - **Architecture**: 3-Tier (Controller → Service → Repository)
 
 ## Prerequisites
-- [Node.js](https://nodejs.org/) (v18+)
+- [Node.js](https://nodejs.org/) (v24+)
 - [Docker](https://www.docker.com/) and Docker Compose (optional, for PostgreSQL)
 - A [Google Gemini API Key](https://aistudio.google.com/) or [Anthropic API Key](https://console.anthropic.com/)
 
 ## Quick Start
 
-### 1. Install Dependencies
+### 1. Choose an installation path
+
+**Option A: install the packaged CLI**
+
+```bash
+npm install -g @bpinhosilva/agent-orchestrator
+agent-orchestrator --help
+```
+
+**Option B: run from a source checkout**
 
 ```bash
+git clone <repo> && cd agent-orchestrator
 npm install
+npm rebuild
+npm run build:all
 ```
 
-> **Note**: The project uses `ignore-scripts=true` in `.npmrc` for supply chain security. After installing, run `npm rebuild` to compile native modules (bcrypt, sqlite3).
+> **Note**: The project uses `ignore-scripts=true` in `.npmrc` for supply chain security. After installing dependencies from source, run `npm rebuild` to compile native modules (bcrypt, sqlite3).
 
-### 2. Configure Environment
+### 2. Configure the runtime
+
+**CLI-driven setup (recommended for local/runtime installs)**
+
+```bash
+agent-orchestrator setup
+```
+
+The CLI writes `${AGENT_ORCHESTRATOR_HOME}/.env` with user-only permissions (`0600`), can run migrations, and can seed an admin user. It also supports non-interactive setup:
+
+```bash
+agent-orchestrator setup \
+  --yes \
+  --db-type postgres \
+  --database-url postgresql://orchestrator:orchestrator_password@localhost:5433/agent_orchestrator \
+  --provider gemini \
+  --gemini-key your-gemini-api-key \
+  --skip-admin-setup
+```
+
+**Manual `.env` setup**
 
 Create a `.env` file in the project root (or set `AGENT_ORCHESTRATOR_HOME` to point to a directory containing `.env`):
 
@@ -88,6 +120,12 @@ npm run seed:admin
 ### 4. Run the Application
 
 ```bash
+# Packaged/runtime CLI
+agent-orchestrator run
+agent-orchestrator status
+agent-orchestrator logs --lines 50
+agent-orchestrator stop
+
 # Development (API + UI with hot reload)
 npm run dev
 
@@ -240,6 +278,12 @@ npm test -- --testNamePattern="should validate email"
 
 See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
 
+## Additional Documentation
+
+- [CLI reference](docs/CLI.md)
+- [CI/CD pipeline](docs/CI_CD.md)
+- [Release process](docs/RELEASE.md)
+
 ## License
 
 See [LICENSE](LICENSE) for details.

package/dist/cli/index.d.ts

@@ -3,13 +3,29 @@ export declare const PID_DIR: string;
 export declare const PID_FILE: string;
 export declare const LOG_FILE: string;
 export declare const ENV_PATH: string;
+export declare const PROCESS_FILE: string;
 export declare const PACKAGE_ROOT: string;
+interface SetupAdminOptions {
+    interactive?: boolean;
+    name?: string;
+    email?: string;
+    password?: string;
+}
+interface ManagedProcess {
+    pid: number;
+    source: 'metadata' | 'pid-file' | 'scan';
+    cwd: string;
+    mainPath: string;
+    port: string;
+}
+export declare function findManagedProcess(): ManagedProcess | null;
 export declare function checkIfRunning(): number | null;
 export declare function checkPendingMigrations(): Promise<{
     hasPending: boolean;
     isEmpty: boolean;
 }>;
 export declare function runMigrations(force?: boolean): Promise<void>;
-export declare function setupAdminUser(): Promise<void>;
+export declare function setupAdminUser(options?: SetupAdminOptions): Promise<void>;
 export declare function defineCommands(): void;
 export declare function runCli(argv?: string[]): Promise<void>;
+export {};