everything-dev/dist/contract.meta.mjs

A consolidated product package for building Module Federation apps with oRPC APIs.

//#region src/contract.meta.ts
const cliCommandMeta = {
	dev: {
		commandPath: ["dev"],
		summary: "Start a development session",
		interactive: true,
		longRunning: true,
		fields: {
			remotePlugins: { description: "Comma-separated plugin IDs to force remote (e.g. --remote-plugins auth,registry)" },
			logLevel: { description: "Log tail level: error, warn (default), info, or debug (overrides BOS_LOG_LEVEL; the file always gets everything)" }
		}
	},
	start: {
		commandPath: ["start"],
		summary: "Start the production host",
		interactive: false,
		longRunning: true,
		fields: {
			env: { description: "Environment: production or staging" },
			registry: { description: "Override FastKV registry contract account (defaults: dev.everything.near / dev.allthethings.testnet)" },
			configPath: { description: "Boot from a local bos config file — skips FastKV resolution and SRI integrity verification" }
		}
	},
	build: {
		commandPath: ["build"],
		summary: "Build selected workspaces",
		interactive: false,
		fields: { packages: {
			positional: true,
			description: "Comma-separated package list"
		} }
	},
	config: {
		commandPath: ["config"],
		summary: "Print the loaded BOS configuration",
		interactive: false,
		fields: { full: { description: "Print the fully resolved configuration" } }
	},
	registryUse: {
		commandPath: ["registry", "use"],
		summary: "Compose app.ui/app.host/app.api/plugins.<key> sections from a published runtime into bos.config.json",
		interactive: false,
		fields: {
			from: {
				positional: true,
				description: "Published runtime (account/gateway or bos:// URL), e.g. v1.citynode.near/citynode.app"
			},
			sections: { description: "Comma-separated sections to compose, e.g. app.ui,plugins.apps" },
			dryRun: { description: "Preview the merged config without writing" }
		}
	},
	pluginAdd: {
		commandPath: ["plugin", "add"],
		summary: "Add a plugin attachment",
		interactive: false,
		fields: {
			source: {
				positional: true,
				description: "Plugin source (local:path, bos://account/domain, or URL)"
			},
			as: { description: "Plugin alias" },
			production: { description: "Production URL override" }
		}
	},
	pluginRemove: {
		commandPath: ["plugin", "remove"],
		summary: "Remove a plugin attachment",
		interactive: false,
		fields: { key: {
			positional: true,
			description: "Plugin key"
		} }
	},
	pluginList: {
		commandPath: ["plugin", "list"],
		summary: "List configured plugins",
		interactive: false
	},
	pluginPublish: {
		commandPath: ["plugin", "publish"],
		summary: "Publish a single plugin",
		interactive: false,
		fields: { key: {
			positional: true,
			description: "Plugin key"
		} }
	},
	publish: {
		commandPath: ["publish"],
		summary: "Publish the current workspace configuration (no build — use bos deploy for the full train)",
		interactive: false,
		fields: {
			dryRun: { description: "Preview what would be published without writing" },
			verbose: { description: "Show full build output instead of clean summary" },
			env: { description: "Environment: production or staging" },
			network: { description: "NEAR network: mainnet or testnet" },
			wallet: { description: "Publish gaslessly with a one-time wallet approval (NEP-366 delegate action relayed by the platform relayer)" },
			registry: { description: "Override FastKV registry contract account (defaults: dev.everything.near / dev.allthethings.testnet)" }
		}
	},
	rollback: {
		commandPath: ["rollback"],
		summary: "Republish an earlier config snapshot from the registry publish history",
		interactive: true,
		fields: {
			version: { description: "Block height (or timestamp) of the snapshot from the listing" },
			previous: { description: "Roll back to the write immediately before the current one" },
			force: { description: "Allow pre-Phase-A snapshots without verifiable manifest pins (their bytes were overwritten in place)" },
			limit: { description: "Listing depth (1-200, default 20)" },
			dryRun: { description: "Preview the rollback without publishing" },
			env: { description: "Environment: production or staging" },
			network: { description: "NEAR network: mainnet or testnet" },
			wallet: { description: "Publish gaslessly with a one-time wallet approval (NEP-366 delegate action relayed by the platform relayer)" },
			registry: { description: "Override FastKV registry contract account (defaults: dev.everything.near / dev.allthethings.testnet)" }
		}
	},
	deploy: {
		commandPath: ["deploy"],
		summary: "Deploy train: preflight → build → upload bundles → publish config → runtime image (pre-pushed digest or local docker build) → Railway (pull-only)",
		interactive: false,
		fields: {
			env: { description: "Environment: production or staging" },
			build: { description: "Build and deploy workspaces before publish (default: true)" },
			dryRun: { description: "Preview what would be deployed without writing" },
			verbose: { description: "Show full build output instead of clean summary" },
			service: { description: "Override Railway service name from config" },
			imageDigest: { description: "Digest of a pre-pushed runtime image (sha256:…) — skips the local image build/push; Railway pins this digest" },
			registry: { description: "Override FastKV registry contract account (defaults: dev.everything.near / dev.allthethings.testnet)" }
		}
	},
	login: {
		commandPath: ["login"],
		summary: "Sign in with your NEAR account via the hosted site (wallet, passkey, or social login)",
		interactive: true,
		fields: {
			key: { description: "Also mint and export a scoped publish key for headless/CI use" },
			site: { description: "Override site URL hosting the CLI login page" },
			device: { description: "Device label recorded on the credential (default: hostname)" },
			expiresIn: { description: "Session lifetime in seconds (default: 90 days)" },
			env: { description: "Environment: production (default) or staging" }
		}
	},
	logout: {
		commandPath: ["logout"],
		summary: "Revoke the stored CLI session and delete the exported publish key",
		interactive: false
	},
	keyPublish: {
		commandPath: ["key", "generate"],
		summary: "Generate a publish access key",
		interactive: true,
		fields: {
			env: { description: "Environment: production or staging" },
			allowance: { description: "NEAR allowance for the key (default: 1NEAR, min: 0.3NEAR)" },
			removeOldKeys: { description: "Remove existing publish key(s) without prompting (default: ask on a TTY, yes when non-interactive)" },
			registry: { description: "Override FastKV registry contract account (defaults: dev.everything.near / dev.allthethings.testnet)" }
		}
	},
	init: {
		commandPath: ["init"],
		summary: "Scaffold a new project by extending a deployed app or template",
		interactive: true,
		fields: {
			domain: {
				positional: true,
				description: "New project domain (e.g. myapp.everything.dev)"
			},
			extends: { description: "Parent to extend from (e.g. bos://account/gateway or account/gateway)" },
			account: { description: "New project NEAR account (auto-derived from extends)" },
			directory: { description: "Target directory (auto-derived from domain)" },
			source: { description: "Local source dir (skips GitHub download)" },
			plugins: { description: "Comma-separated plugin keys to include (requires --overrides=plugins)" },
			overrides: { description: "Comma-separated sections to customize locally: ui,api,host,plugins" },
			level: { description: "Starter complexity: simple (public shell) or advanced (adds dashboard, orgs, admin)" },
			noInteractive: { description: "Skip prompts, use flags only" },
			noInstall: { description: "Skip pnpm install" }
		}
	},
	sync: {
		commandPath: ["sync"],
		summary: "Sync template files from parent project",
		interactive: false,
		fields: {
			dryRun: { description: "Preview changes without writing files" },
			noInstall: { description: "Skip pnpm install" }
		}
	},
	upgrade: {
		commandPath: ["upgrade"],
		summary: "Upgrade framework packages and sync template files",
		interactive: true,
		fields: {
			dryRun: { description: "Preview changes without writing" },
			noInstall: { description: "Skip pnpm install" },
			noSync: { description: "Only upgrade packages, skip template sync" }
		}
	},
	typesGen: {
		commandPath: ["types", "gen"],
		summary: "Generate type definitions from configured API and plugin contracts",
		interactive: false,
		fields: {
			env: { description: "Environment: development (default) or production" },
			dryRun: { description: "Preview what would be fetched without writing files" },
			remotePlugins: { description: "Comma-separated plugin IDs to fetch contract types remotely (e.g. --remote-plugins auth,registry)" }
		}
	},
	typecheck: {
		commandPath: ["typecheck"],
		summary: "Run TypeScript type checking across all local workspaces",
		interactive: false,
		fields: { packages: {
			positional: true,
			description: "Comma-separated workspace list (default: all)"
		} }
	},
	mfCheck: {
		commandPath: ["mf", "check"],
		summary: "Verify Module Federation runtime compatibility across published host + plugin bundles",
		interactive: false
	},
	dbStudio: {
		commandPath: ["db", "studio"],
		summary: "Open Drizzle Studio for a plugin's database",
		fields: { plugin: {
			positional: true,
			description: "Plugin key: api, auth, or a plugin name (default: api)"
		} }
	},
	dbDoctor: {
		commandPath: ["db", "doctor"],
		summary: "Diagnose migration health for a plugin's database",
		fields: { plugin: {
			positional: true,
			description: "Plugin key: api, auth, or a plugin name"
		} }
	},
	dbRepair: {
		commandPath: ["db", "repair"],
		summary: "Reset migration history and reapply migrations for a plugin",
		fields: {
			plugin: {
				positional: true,
				description: "Plugin key: api, auth, or a plugin name"
			},
			mode: { description: "Repair mode: history-reset (default) or recreate (not yet supported)" },
			yes: { description: "Skip confirmation prompt" }
		}
	},
	status: {
		commandPath: ["status"],
		summary: "Show project health, versions, and update availability",
		interactive: false
	},
	ps: {
		commandPath: ["ps"],
		summary: "List tracked development processes",
		interactive: false
	},
	logs: {
		commandPath: ["logs"],
		summary: "Read dev session logs (.bos/logs/dev-latest.log)",
		interactive: false,
		fields: {
			service: { description: "Filter by service name (e.g. host, api, auth, ui, plugin:votes)" },
			tail: { description: "Show only the last N lines" },
			follow: { description: "Stream the log as lines are appended" }
		}
	},
	kill: {
		commandPath: ["kill"],
		summary: "Stop tracked development processes",
		interactive: false,
		fields: {
			configDir: { description: "Kill processes owned by a config directory (defaults to cwd)" },
			signal: { description: "Signal: SIGTERM (default) or SIGKILL" },
			all: { description: "Kill processes across all config directories" }
		}
	},
	infraExport: {
		commandPath: ["infra", "export"],
		summary: "Emit the resolved CI infra plan (env + services) for the current runtime",
		interactive: false,
		fields: {
			target: { description: "Export target: ci (default) or local" },
			network: { description: "NEAR network: mainnet or testnet" },
			configDir: { description: "Override config directory" }
		}
	}
};

//#endregion
export { cliCommandMeta };
//# sourceMappingURL=contract.meta.mjs.map