everything-dev
Version:
A consolidated product package for building Module Federation apps with oRPC APIs.
193 lines • 6.01 kB
text/typescript
//#region src/contract.meta.d.ts
type CliCommandMeta = {
commandPath?: string[];
summary: string;
description?: string;
examples?: string[];
interactive?: boolean;
longRunning?: boolean;
fields?: Record<string, {
positional?: boolean;
description?: string;
}>;
};
declare const cliCommandMeta: {
readonly dev: {
readonly commandPath: ["dev"];
readonly summary: "Start a development session";
readonly interactive: true;
readonly longRunning: true;
};
readonly start: {
readonly commandPath: ["start"];
readonly summary: "Start the production host";
readonly interactive: false;
readonly longRunning: true;
readonly fields: {
readonly env: {
readonly description: "Environment: production or staging";
};
};
};
readonly build: {
readonly commandPath: ["build"];
readonly summary: "Build selected workspaces";
readonly interactive: false;
readonly fields: {
readonly packages: {
readonly positional: true;
readonly description: "Comma-separated package list";
};
};
};
readonly config: {
readonly commandPath: ["config"];
readonly summary: "Print the loaded BOS configuration";
readonly interactive: false;
};
readonly pluginAdd: {
readonly commandPath: ["plugin", "add"];
readonly summary: "Add a plugin attachment";
readonly interactive: false;
readonly fields: {
readonly source: {
readonly positional: true;
readonly description: "Plugin source (local:path, bos://account/domain, or URL)";
};
readonly as: {
readonly description: "Plugin alias";
};
readonly production: {
readonly description: "Production URL override";
};
};
};
readonly pluginRemove: {
readonly commandPath: ["plugin", "remove"];
readonly summary: "Remove a plugin attachment";
readonly interactive: false;
readonly fields: {
readonly key: {
readonly positional: true;
readonly description: "Plugin key";
};
};
};
readonly pluginList: {
readonly commandPath: ["plugin", "list"];
readonly summary: "List configured plugins";
readonly interactive: false;
};
readonly pluginPublish: {
readonly commandPath: ["plugin", "publish"];
readonly summary: "Publish a single plugin";
readonly interactive: false;
readonly fields: {
readonly key: {
readonly positional: true;
readonly description: "Plugin key";
};
};
};
readonly publish: {
readonly commandPath: ["publish"];
readonly summary: "Publish the current workspace configuration";
readonly interactive: false;
};
readonly keyPublish: {
readonly commandPath: ["key", "publish"];
readonly summary: "Generate a publish access key";
readonly interactive: false;
};
readonly init: {
readonly commandPath: ["init"];
readonly summary: "Scaffold a new project by extending a deployed app or template";
readonly interactive: true;
readonly fields: {
readonly domain: {
readonly positional: true;
readonly description: "New project domain (e.g. myapp.everything.dev)";
};
readonly extends: {
readonly description: "Parent to extend from (e.g. bos://account/gateway or account/gateway)";
};
readonly account: {
readonly description: "New project NEAR account (auto-derived from extends)";
};
readonly directory: {
readonly description: "Target directory (auto-derived from domain)";
};
readonly source: {
readonly description: "Local source dir (skips GitHub download)";
};
readonly plugins: {
readonly description: "Comma-separated plugin keys to include (requires --overrides=plugins)";
};
readonly overrides: {
readonly description: "Comma-separated sections to customize locally: ui,api,host,plugins";
};
readonly noInteractive: {
readonly description: "Skip prompts, use flags only";
};
readonly noInstall: {
readonly description: "Skip bun install";
};
};
};
readonly sync: {
readonly commandPath: ["sync"];
readonly summary: "Sync template files from parent project";
readonly interactive: false;
readonly fields: {
readonly dryRun: {
readonly description: "Preview changes without writing files";
};
readonly force: {
readonly description: "Overwrite user-modified files";
};
readonly noInstall: {
readonly description: "Skip bun install";
};
};
};
readonly upgrade: {
readonly commandPath: ["upgrade"];
readonly summary: "Upgrade framework packages and sync template files";
readonly interactive: true;
readonly fields: {
readonly dryRun: {
readonly description: "Preview changes without writing";
};
readonly force: {
readonly description: "Overwrite user-modified files during sync";
};
readonly noInstall: {
readonly description: "Skip bun install";
};
readonly noSync: {
readonly description: "Only upgrade packages, skip template sync";
};
};
};
readonly typesGen: {
readonly commandPath: ["types", "gen"];
readonly summary: "Generate type definitions from configured API and plugin contracts";
readonly interactive: false;
readonly fields: {
readonly env: {
readonly description: "Environment: development (default) or production";
};
readonly dryRun: {
readonly description: "Preview what would be fetched without writing files";
};
};
};
readonly status: {
readonly commandPath: ["status"];
readonly summary: "Show project health, versions, and update availability";
readonly interactive: false;
};
};
//#endregion
export { CliCommandMeta, cliCommandMeta };
//# sourceMappingURL=contract.meta.d.cts.map