@zero.core/cli 1.0.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/NOTICE

@@ -0,0 +1,7 @@
+ZeroCore CLI
+Copyright 2026 Division by Zero P.C.
+
+This product includes software developed for the ZeroCore project.
+Redistributions and derivative works must retain this NOTICE attribution
+in source form, documentation, a NOTICE file, or an appropriate generated
+third-party notices display, as required by the Apache License 2.0.

package/README.md

@@ -0,0 +1,240 @@
+# ZeroCore CLI
+
+`@zero.core/cli` is the general command-line tool for the ZeroCore ecosystem. It is not limited to `@zero.core/api-framework`, but the first implemented command group focuses on API project creation, API code generation, OpenAPI utilities, DI inspection, scheduled task operations, pub/sub inspection, and client generation.
+
+## Install
+
+During local development, run it from this package directory:
+
+```bash
+cd packages/zerocore-cli
+yarn install --ignore-scripts
+yarn dev -- --help
+```
+
+The CLI package does not depend on `@zero.core/api-framework` at install time.
+API projects generated by the CLI declare their own framework dependency.
+
+Install the published package from npm:
+
+```bash
+npm install -D @zero.core/cli
+npx zerocore --help
+```
+
+The CLI performs a best-effort version check against the npm registry and writes update notices to stderr. It never fails a command when the registry is unavailable. Disable the check with `--no-version-check` or `ZEROCORE_CLI_VERSION_CHECK=0`.
+
+## Commands
+
+### Project Scaffolding
+
+Create a new API project:
+
+```bash
+zerocore new api orders-api --dir apps
+```
+
+This creates a TypeScript Express API using `@zero.core/api-framework`, controller discovery, `ServiceContainer`, global error handling, and a health endpoint.
+
+Create a generic app or package:
+
+```bash
+zerocore new app worker-service --dir apps
+zerocore new package contracts --dir packages
+```
+
+Use `--force` to overwrite existing generated files.
+
+### API Generation
+
+Generate a complete CRUD-style resource:
+
+```bash
+zerocore api generate resource Project --dir src
+```
+
+This creates:
+
+- `src/models/ProjectModels.ts`
+- `src/services/ProjectService.ts`
+- `src/controllers/ProjectsController.ts`
+- `test/ProjectsController.test.ts`
+
+Generate individual pieces:
+
+```bash
+zerocore api generate controller Project --dir src
+zerocore api generate service Project --dir src
+zerocore api generate dto ProjectDto --dir src
+zerocore api generate test Projects --dir src
+zerocore api generate subscriber ProjectEvents --topic projects.created --provider redis-streams --dir src
+```
+
+Generated controllers use C#-style ZeroCore decorators such as `@ApiController`, `@Route`, `@HttpGet`, `@FromRoute`, `@FromBody`, `@ProducesResponseType`, and explicit `@Inject` constructor metadata.
+
+Generated subscribers use `@Subscribe`, `@MessageBody`, `@MessageEnvelope`, and provider-agnostic framework imports from `@zero.core/api-framework`.
+
+### Doctor
+
+Inspect an API project for common framework convention issues:
+
+```bash
+zerocore doctor api --dir apps/api
+zerocore doctor api --dir apps/api --json
+```
+
+Current checks include controller metadata, route metadata, response metadata, model metadata, and basic project structure.
+
+### OpenAPI Utilities
+
+Validate an OpenAPI document:
+
+```bash
+zerocore api openapi validate openapi.json
+```
+
+Print an OpenAPI document:
+
+```bash
+zerocore api openapi print openapi.json
+zerocore api openapi print openapi.json --min
+```
+
+Diff two OpenAPI documents:
+
+```bash
+zerocore api openapi diff openapi-v1.json openapi-v2.json
+zerocore api openapi diff openapi-v1.json openapi-v2.json --json
+```
+
+The diff command exits with code `1` when removed operations or schemas are detected.
+
+### Client Generation
+
+Generate a lightweight fetch client from an OpenAPI document:
+
+```bash
+zerocore api client generate \
+  --input openapi.json \
+  --output src/generated/client.ts \
+  --name ZeroCoreClient
+```
+
+Use `--options-name` to customize the generated client options interface name.
+
+### DI Inspection
+
+Print a static dependency graph:
+
+```bash
+zerocore api di graph --dir src
+zerocore api di graph --dir src --json
+```
+
+Validate explicit DI metadata:
+
+```bash
+zerocore api di validate --dir src
+```
+
+The validator reports constructor parameters without explicit metadata and simple circular dependencies discovered from `@Inject`, `@Injectable(...tokens)`, and static `inject`/`dependencies` arrays.
+
+### Scheduled Tasks
+
+List tasks discovered from a task directory:
+
+```bash
+zerocore api tasks list --dir src/tasks
+zerocore api tasks list --dir src/tasks --json
+```
+
+Directory discovery loads `@zero.core/api-framework` from the target API project,
+so that project must have the framework installed.
+
+Run one task by name:
+
+```bash
+zerocore api tasks run cleanup --dir src/tasks
+```
+
+For projects with custom DI setup, export a scheduler from a module:
+
+```bash
+zerocore api tasks list --module src/tasks/scheduler.ts
+zerocore api tasks run cleanup --module src/tasks/scheduler.ts
+```
+
+The module may export `scheduler`, `default`, `createScheduler`, or `createTaskScheduler`.
+
+### Pub/Sub
+
+List the implemented provider packages and their provider registration classes:
+
+```bash
+zerocore api pubsub providers
+zerocore api pubsub providers --json
+```
+
+Scan decorated subscribers:
+
+```bash
+zerocore api pubsub scan --dir src
+zerocore api pubsub scan --dir src --json
+```
+
+Validate subscriber metadata:
+
+```bash
+zerocore api pubsub validate --dir src
+```
+
+The scanner is static and checks `@Subscribe(...)` usage without requiring the target API project to execute.
+
+## Current Scope
+
+Implemented:
+
+- project scaffolding
+- API resource/controller/service/DTO/test generation
+- API doctor checks
+- OpenAPI validate/print/diff
+- TypeScript client generation from OpenAPI
+- DI graph and validation
+- scheduled task list/run helpers
+- pub/sub provider catalog, subscriber scanning, subscriber validation, and subscriber generation
+- best-effort update notices for newer published CLI versions
+
+Not implemented in this package yet:
+
+- documentation site helpers
+- agent setup/publishing helpers
+
+## Verification
+
+```bash
+cd packages/zerocore-cli
+yarn typecheck
+yarn test
+yarn build
+```
+
+For the full staged gate:
+
+```bash
+yarn test:production
+```
+
+Stage meaning:
+
+- `typecheck` verifies CLI source, command contracts, and generated TypeScript helper code.
+- `test` runs command-level tests for entrypoint behavior, scaffolding, generation, doctor checks, OpenAPI utilities, client generation, DI inspection, task commands, package contracts, and failure paths.
+- `build` verifies the publishable `dist` binary and declarations are emitted.
+
+## Production Notes
+
+- The runtime binary is `zerocore`.
+- The CLI package itself does not depend on `@zero.core/api-framework`; generated API projects declare their own framework dependency.
+- Commands should return non-zero exit codes with concise stderr diagnostics when validation fails.
+- Version update notices are written to stderr, are skipped in CI by default, and can be disabled with `--no-version-check` or `ZEROCORE_CLI_VERSION_CHECK=0`.
+- The npm package payload is compiled `dist` output plus `README.md`, `LICENSE`, and `NOTICE`.
+- Do not document or add docs-helper, agent setup, publishing, or marketplace commands unless they are explicitly implemented.

package/dist/cli.d.ts

@@ -0,0 +1,4 @@
+import { CliResult } from "./context";
+import type { CliContext } from "./context";
+export declare function runCli(argv: string[], context: CliContext): Promise<CliResult>;
+//# sourceMappingURL=cli.d.ts.map

package/dist/commands/apiGenerateCommand.d.ts

@@ -0,0 +1,4 @@
+import { CliResult } from "../context";
+import type { CliContext } from "../context";
+export declare function runApiGenerateCommand(positionals: string[], options: Map<string, string | boolean>, context: CliContext): Promise<CliResult>;
+//# sourceMappingURL=apiGenerateCommand.d.ts.map

package/dist/commands/clientCommand.d.ts

@@ -0,0 +1,4 @@
+import { CliResult } from "../context";
+import type { CliContext } from "../context";
+export declare function runApiClientCommand(positionals: string[], options: Map<string, string | boolean>, context: CliContext): Promise<CliResult>;
+//# sourceMappingURL=clientCommand.d.ts.map

package/dist/commands/diCommand.d.ts

@@ -0,0 +1,4 @@
+import { CliResult } from "../context";
+import type { CliContext } from "../context";
+export declare function runApiDiCommand(positionals: string[], options: Map<string, string | boolean>, context: CliContext): Promise<CliResult>;
+//# sourceMappingURL=diCommand.d.ts.map

package/dist/commands/doctorCommand.d.ts

@@ -0,0 +1,19 @@
+import { CliResult } from "../context";
+import type { CliContext } from "../context";
+export declare function runDoctorCommand(positionals: string[], options: Map<string, string | boolean>, context: CliContext): Promise<CliResult>;
+export type DiagnosticSeverity = "error" | "warning" | "info";
+export interface Diagnostic {
+    severity: DiagnosticSeverity;
+    file?: string;
+    message: string;
+}
+export interface DoctorReport {
+    diagnostics: Diagnostic[];
+    stats: DoctorStats;
+}
+export interface DoctorStats {
+    controllers: number;
+    models: number;
+    services: number;
+}
+//# sourceMappingURL=doctorCommand.d.ts.map

package/dist/commands/newCommand.d.ts

@@ -0,0 +1,4 @@
+import { CliResult } from "../context";
+import type { CliContext } from "../context";
+export declare function runNewCommand(positionals: string[], options: Map<string, string | boolean>, context: CliContext): Promise<CliResult>;
+//# sourceMappingURL=newCommand.d.ts.map

package/dist/commands/openApiCommand.d.ts

@@ -0,0 +1,4 @@
+import { CliResult } from "../context";
+import type { CliContext } from "../context";
+export declare function runOpenApiCommand(positionals: string[], options: Map<string, string | boolean>, context: CliContext): Promise<CliResult>;
+//# sourceMappingURL=openApiCommand.d.ts.map

package/dist/commands/pubSubCommand.d.ts

@@ -0,0 +1,35 @@
+import { CliResult } from "../context";
+import type { CliContext } from "../context";
+export declare function runApiPubSubCommand(positionals: string[], options: Map<string, string | boolean>, context: CliContext): Promise<CliResult>;
+export interface PubSubProviderCatalogItem {
+    name: string;
+    packageName: string;
+    providerName: string;
+    broker: string;
+    install: string;
+}
+export interface PubSubScanReport {
+    subscribers: PubSubSubscriberInfo[];
+    diagnostics: PubSubDiagnostic[];
+}
+export interface PubSubSubscriberInfo {
+    className: string;
+    methodName: string;
+    topic: string;
+    provider: string;
+    subscriptionName?: string;
+    enabled: boolean;
+    file: string;
+}
+export interface PubSubDiagnostic {
+    severity: "error" | "warning" | "info";
+    file?: string;
+    message: string;
+}
+export interface PubSubValidationReport {
+    errors: string[];
+    warnings: string[];
+    subscribers: number;
+}
+export declare const PUBSUB_PROVIDERS: PubSubProviderCatalogItem[];
+//# sourceMappingURL=pubSubCommand.d.ts.map

package/dist/commands/tasksCommand.d.ts

@@ -0,0 +1,4 @@
+import { CliResult } from "../context";
+import type { CliContext } from "../context";
+export declare function runApiTasksCommand(positionals: string[], options: Map<string, string | boolean>, context: CliContext): Promise<CliResult>;
+//# sourceMappingURL=tasksCommand.d.ts.map

package/dist/context.d.ts

@@ -0,0 +1,23 @@
+import { Writable } from "node:stream";
+import type { VersionChecker } from "./utils/versionCheck";
+export interface CliContext {
+    cwd: string;
+    stdout: Writable;
+    stderr: Writable;
+    env: NodeJS.ProcessEnv;
+    versionChecker?: VersionChecker;
+}
+export declare class CliResult {
+    readonly exitCode: number;
+    constructor(exitCode?: number);
+}
+export declare class CliError extends Error {
+    readonly exitCode: number;
+    constructor(message: string, exitCode?: number);
+}
+export declare class BufferedWritable extends Writable {
+    private readonly chunks;
+    _write(chunk: Buffer | string, _encoding: BufferEncoding, callback: (error?: Error | null) => void): void;
+    text(): string;
+}
+//# sourceMappingURL=context.d.ts.map

package/dist/index.d.ts

@@ -0,0 +1,6 @@
+#!/usr/bin/env node
+export { runCli } from "./cli";
+export { CliError, CliResult, BufferedWritable } from "./context";
+export { CLI_PACKAGE_NAME, CLI_VERSION, compareVersions } from "./utils/versionCheck";
+export type { VersionChecker } from "./utils/versionCheck";
+//# sourceMappingURL=index.d.ts.map