@rebasepro/cli 0.9.0 → 0.9.1-canary.0fce67c

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (45) hide show
  1. package/README.md +32 -3
  2. package/dist/commands/cloud/auth.d.ts +3 -0
  3. package/dist/commands/cloud/context.d.ts +157 -0
  4. package/dist/commands/cloud/databases.d.ts +1 -0
  5. package/dist/commands/cloud/deploy.d.ts +2 -0
  6. package/dist/commands/cloud/deployments.d.ts +39 -0
  7. package/dist/commands/cloud/domains.d.ts +1 -0
  8. package/dist/commands/cloud/env.d.ts +6 -0
  9. package/dist/commands/cloud/extensions.d.ts +3 -0
  10. package/dist/commands/cloud/index.d.ts +1 -0
  11. package/dist/commands/cloud/link.d.ts +5 -0
  12. package/dist/commands/cloud/orgs.d.ts +1 -0
  13. package/dist/commands/cloud/power.d.ts +4 -0
  14. package/dist/commands/cloud/projects.d.ts +13 -0
  15. package/dist/commands/cloud/resources.d.ts +6 -0
  16. package/dist/commands/cloud/settings.d.ts +8 -0
  17. package/dist/commands/init.d.ts +23 -0
  18. package/dist/commands/skills.d.ts +1 -1
  19. package/dist/index.d.ts +1 -0
  20. package/dist/index.es.js +5253 -1830
  21. package/dist/index.es.js.map +1 -1
  22. package/dist/utils/package-manager.d.ts +19 -5
  23. package/dist/utils/project.d.ts +1 -1
  24. package/package.json +8 -7
  25. package/templates/overlays/baas/README.md +55 -0
  26. package/templates/overlays/baas/backend/package.json +31 -0
  27. package/templates/overlays/baas/backend/src/index.ts +192 -0
  28. package/templates/overlays/baas/backend/tsconfig.json +19 -0
  29. package/templates/overlays/baas/package.json +42 -0
  30. package/templates/overlays/baas/pnpm-workspace.yaml +9 -0
  31. package/templates/template/.env.example +25 -3
  32. package/templates/template/backend/functions/hello.ts +1 -1
  33. package/templates/template/backend/package.json +6 -7
  34. package/templates/template/backend/src/env.ts +31 -2
  35. package/templates/template/backend/src/index.ts +21 -16
  36. package/templates/template/config/collections/index.ts +20 -0
  37. package/templates/template/config/collections/presets/blank/index.ts +3 -1
  38. package/templates/template/config/collections/presets/ecommerce/index.ts +3 -1
  39. package/templates/template/config/collections/users.ts +2 -0
  40. package/templates/template/config/package.json +1 -2
  41. package/templates/template/frontend/package.json +2 -3
  42. package/templates/template/frontend/src/App.tsx +3 -4
  43. package/templates/template/frontend/vite.config.ts +1 -1
  44. package/templates/template/gitignore +31 -0
  45. package/templates/template/npmrc +10 -0
package/README.md CHANGED
@@ -26,9 +26,38 @@ The CLI is also bundled with every Rebase project as a local dependency.
26
26
  | `rebase generate-sdk` | Generate a typed TypeScript SDK from collections |
27
27
  | `rebase auth reset-password` | Reset a user's password |
28
28
  | `rebase doctor` | Detect schema drift between collections, Drizzle schema, and database |
29
+ | `rebase cloud <command>` | Manage your apps on Rebase Cloud (auth, deploy, databases, …) |
29
30
 
30
31
  Run `rebase --help` or `rebase <command> --help` for detailed usage.
31
32
 
33
+ ## Rebase Cloud
34
+
35
+ `rebase cloud` talks to the hosted control plane (default `https://app.rebase.pro`,
36
+ override with `--url` or `REBASE_CLOUD_URL`). Sign in once — credentials are stored
37
+ in `~/.rebase/credentials.json`, keyed per host — then link a directory to a project
38
+ so deploy/logs/status need no flags.
39
+
40
+ ```bash
41
+ rebase cloud login # sign in (stores a session)
42
+ rebase cloud link # pick a project → writes .rebase/cloud.json
43
+ rebase cloud deploy # deploy the linked project + stream build logs
44
+ rebase cloud logs --runtime # tail runtime logs
45
+ rebase cloud status # project status at a glance
46
+ ```
47
+
48
+ | Group | Commands |
49
+ |-------|----------|
50
+ | Auth | `login`, `logout`, `whoami` |
51
+ | Link/context | `link`, `unlink`, `use [org]`, `open` |
52
+ | Projects | `projects list \| create \| info \| delete` |
53
+ | Deploy/observe | `deploy`, `logs [--runtime] [-f]`, `status`, `metrics` |
54
+ | Organizations | `orgs list \| create \| members` |
55
+ | Databases | `db list \| create \| test`, `db backup list \| create \| restore` |
56
+ | Resources | `webhooks list \| create \| delete`, `storage`, `clusters`, `billing [checkout]` |
57
+
58
+ Most commands act on the linked project unless you pass `--project <id>`.
59
+ Run `rebase cloud --help` for the full list.
60
+
32
61
  ## Quick Start
33
62
 
34
63
  ```bash
@@ -43,7 +72,7 @@ pnpm run dev
43
72
 
44
73
  | Package | Role |
45
74
  |---------|------|
46
- | `@rebasepro/server-core` | Backend framework used by `dev` and `start` |
47
- | `@rebasepro/server-postgresql` | PostgreSQL driver used by schema/db commands |
48
- | `@rebasepro/sdk-generator` | Powers `generate-sdk` |
75
+ | `@rebasepro/server` | Backend framework used by `dev` and `start` |
76
+ | `@rebasepro/server-postgres` | PostgreSQL driver used by schema/db commands |
77
+ | `@rebasepro/codegen` | Powers `generate-sdk` |
49
78
  | `@rebasepro/types` | Shared type definitions |
@@ -0,0 +1,3 @@
1
+ export declare function loginCommand(rawArgs: string[]): Promise<void>;
2
+ export declare function logoutCommand(rawArgs: string[]): Promise<void>;
3
+ export declare function whoamiCommand(rawArgs: string[]): Promise<void>;
@@ -0,0 +1,157 @@
1
+ import { createRebaseClient } from "@rebasepro/client";
2
+ /** Default hosted control plane (the Rebase Cloud console origin). */
3
+ export declare const DEFAULT_CLOUD_URL = "https://app.rebase.pro";
4
+ /** Project-local link file: <project>/.rebase/cloud.json */
5
+ export declare function projectLinkPath(cwd?: string): string;
6
+ /** Host that a bare `rebase cloud` command should target, if any. */
7
+ export declare function currentContextUrl(): string | undefined;
8
+ /** Persist the active organization id for a host. */
9
+ export declare function setContextOrg(url: string, org: string | undefined): void;
10
+ export declare function getContextOrg(url: string): string | undefined;
11
+ /** Mark a host as the active context (called on login). */
12
+ export declare function setCurrentContext(url: string): void;
13
+ export declare function resolveCloudUrl(rawArgs: string[]): string;
14
+ export type CloudClient = ReturnType<typeof createRebaseClient>;
15
+ /**
16
+ * Build an SDK client bound to a control-plane host, backed by the on-disk
17
+ * credential store. `autoRefresh` is disabled so we never leave a dangling
18
+ * setTimeout that keeps the CLI process alive; token refresh is done on demand
19
+ * by `requireClient`.
20
+ */
21
+ export declare function createCloudClient(url: string): CloudClient;
22
+ /**
23
+ * Return an authenticated client for the resolved host, refreshing the access
24
+ * token if it is close to expiry. Exits with a helpful message when there is no
25
+ * usable session (never logged in, or the refresh token was revoked).
26
+ */
27
+ export declare function requireClient(rawArgs: string[]): Promise<{
28
+ client: CloudClient;
29
+ url: string;
30
+ }>;
31
+ export declare function fetchTenantBaseDomain(client: CloudClient, url: string): Promise<string | undefined>;
32
+ /**
33
+ * Public host for a project — `<subdomain>.<base>`, or the bare subdomain when
34
+ * the base domain is unknown.
35
+ *
36
+ * It deliberately never falls back to a guessed domain. The user copies this
37
+ * string into a browser, so a plausible-but-wrong hostname is worse than an
38
+ * obviously incomplete one: `acme.rebase.pro` looks reachable and isn't, while
39
+ * `acme` reads as "the subdomain is acme" and prompts no wasted debugging.
40
+ */
41
+ export declare function formatTenantHost(subdomain: string | undefined, baseDomain: string | undefined): string | undefined;
42
+ /** The fields of a project row this module needs to render a host. */
43
+ export interface HostableProject {
44
+ subdomain?: string;
45
+ /** Resolved server-side; absent on control planes older than the host hook. */
46
+ host?: string;
47
+ }
48
+ /**
49
+ * The host to display for a project.
50
+ *
51
+ * Prefers `host` off the record: the control plane resolves it through the same
52
+ * `tenantHost()` the ingress uses, so it accounts for the project's *cluster*
53
+ * base domain. The CLI cannot compute that itself — `clusters` is admin-only
54
+ * under RLS, so a normal user's token cannot read `baseDomain`, and a project on
55
+ * a second cluster is served somewhere the platform default does not name.
56
+ *
57
+ * `baseDomain` (from `platform-config`) remains the fallback for a control plane
58
+ * that predates the hook — right for the single-cluster case, which is every
59
+ * project today.
60
+ */
61
+ export declare function projectHost(project: HostableProject, baseDomain: string | undefined): string | undefined;
62
+ export interface ProjectLink {
63
+ url: string;
64
+ projectId: string;
65
+ /** The project's subdomain — the slug users see in console URLs and type into --project. */
66
+ slug?: string;
67
+ projectName?: string;
68
+ orgId?: string;
69
+ }
70
+ export declare function readLink(cwd?: string): ProjectLink | null;
71
+ export declare function writeLink(link: ProjectLink, cwd?: string): void;
72
+ export declare function removeLink(cwd?: string): boolean;
73
+ /**
74
+ * The raw project reference to operate on: explicit `--project` flag wins,
75
+ * otherwise the linked project. Exits with guidance when neither is present.
76
+ * The value is a slug (the project's subdomain, as shown in console URLs) or,
77
+ * for old scripts and link files, a raw project UUID.
78
+ */
79
+ export declare function requireProjectRef(rawArgs: string[]): string;
80
+ /**
81
+ * Resolve a project reference — slug or UUID — to the internal id the API
82
+ * takes, or undefined when no such project is visible. Slugs cost one lookup;
83
+ * UUIDs pass through untouched so linked directories and old scripts skip the
84
+ * round-trip.
85
+ */
86
+ export declare function lookupProjectId(ref: string, client: CloudClient): Promise<string | undefined>;
87
+ /** Like `lookupProjectId`, but exits with guidance when the ref matches nothing. */
88
+ export declare function resolveProjectRef(ref: string, client: CloudClient): Promise<string>;
89
+ /** `requireProjectRef` + `resolveProjectRef` in one step. */
90
+ export declare function requireProject(rawArgs: string[], client: CloudClient): Promise<string>;
91
+ /**
92
+ * The project reference to SHOW: the slug the user typed or the linked slug.
93
+ * Never resolves — for human output only. Old link files predate `slug` and
94
+ * fall back to the stored id.
95
+ */
96
+ export declare function displayProjectRef(rawArgs: string[]): string;
97
+ /**
98
+ * Resolve and latch the output mode for this invocation. Call once at the top of
99
+ * `cloudCommand`, before anything can print or `fail`. Returns the resolved mode
100
+ * (handy for tests, which otherwise leave it at its `false` default).
101
+ */
102
+ export declare function initOutputMode(rawArgs: string[]): boolean;
103
+ /** Whether the current invocation is emitting machine-readable JSON. */
104
+ export declare function isJsonMode(): boolean;
105
+ /** Force the mode (tests only — production latches it via `initOutputMode`). */
106
+ export declare function setJsonModeForTest(value: boolean): void;
107
+ /** Write one JSON value to stdout, followed by a newline. */
108
+ export declare function printJson(value: unknown): void;
109
+ /**
110
+ * The one output primitive every new command uses: in JSON mode emit `json`
111
+ * (and nothing else); otherwise run `human`. Keeping the two behind a single
112
+ * call is what guarantees a command can never print a table AND a JSON blob.
113
+ */
114
+ export declare function emit(human: () => void, json: unknown): void;
115
+ /** Print an error (+ optional hint) and exit non-zero. Never returns. */
116
+ export declare function fail(message: string, hint?: string, code?: string): never;
117
+ /**
118
+ * Confirm a destructive/irreversible action, respecting non-interactive use.
119
+ *
120
+ * With `--yes`/`-y` it proceeds silently. In JSON mode or a non-TTY it REFUSES
121
+ * to prompt — a prompt that can hang is a known repo landmine — and fails,
122
+ * telling the caller to pass `--yes`. Only an interactive terminal gets a real
123
+ * confirm prompt; declining there aborts cleanly (exit 0).
124
+ */
125
+ export declare function confirmDestructive(opts: {
126
+ yes: boolean;
127
+ prompt: string;
128
+ }): Promise<void>;
129
+ /**
130
+ * Positional tokens after `rebase cloud` — `[group, action, arg1, …]`.
131
+ *
132
+ * Deliberately NOT `arg({}, { permissive: true })._`: in permissive mode `arg`
133
+ * pushes UNKNOWN FLAGS onto `_` too, so `rollback --yes --json` would report
134
+ * `--yes` as the deployment id. Operand extraction must see operands only, so
135
+ * anything starting with `-` is dropped — the same filter the db backup handler
136
+ * has always used.
137
+ */
138
+ export declare function cloudPositionals(rawArgs: string[]): string[];
139
+ export declare function success(message: string): void;
140
+ /** Colorize a deployment / resource status token. */
141
+ export declare function colorStatus(status: string | undefined): string;
142
+ /**
143
+ * Render a two-column key/value block with aligned keys. Empty rows are skipped
144
+ * — including `null`, which the API sends for an unset column and which used to
145
+ * print the literal string "null" (e.g. `Custom domain: null`).
146
+ */
147
+ export declare function keyValues(rows: Array<[string, string | null | undefined]>): void;
148
+ /**
149
+ * Surface an SDK/HTTP error consistently. The SDK throws RebaseApiError with
150
+ * a `.status` and `.message`; anything else falls back to its string form.
151
+ */
152
+ export declare function reportError(e: unknown, context: string): never;
153
+ /**
154
+ * Open a URL in the user's default browser (best effort). Always prints the URL
155
+ * first so it stays usable over SSH or when no browser is available.
156
+ */
157
+ export declare function openUrl(target: string, label?: string): void;
@@ -0,0 +1 @@
1
+ export declare function dbCommand(subcommand: string | undefined, rawArgs: string[]): Promise<void>;
@@ -0,0 +1,2 @@
1
+ export declare function deployCommand(rawArgs: string[], projectRef: string): Promise<void>;
2
+ export declare function logsCommand(rawArgs: string[], projectRef: string): Promise<void>;
@@ -0,0 +1,39 @@
1
+ /** A deployment row, as the data API hands it back (camel or snake columns). */
2
+ export interface DeploymentRow {
3
+ id: string | number;
4
+ status?: string;
5
+ createdAt?: string | Date;
6
+ created_at?: string | Date;
7
+ finishedAt?: string | Date;
8
+ finished_at?: string | Date;
9
+ imageUrl?: string;
10
+ image_url?: string;
11
+ rollbackOf?: string;
12
+ rollback_of?: string;
13
+ triggeredBy?: string;
14
+ triggered_by?: string;
15
+ triggerSource?: string;
16
+ trigger_source?: string;
17
+ triggeredByUserId?: string;
18
+ triggered_by_user_id?: string;
19
+ gitCommitHash?: string;
20
+ gitCommitMessage?: string;
21
+ }
22
+ export declare function deploymentImage(dep: DeploymentRow): string | null;
23
+ /**
24
+ * The backend's rule EXACTLY: a rollback is honoured only for a successful
25
+ * deploy that recorded an image. Any other row 409s `deploy_not_rollbackable`.
26
+ */
27
+ export declare function isRollbackable(dep: DeploymentRow): boolean;
28
+ /** finishedAt − createdAt in ms, or null (still running / missing / skewed). */
29
+ export declare function deploymentDurationMs(dep: DeploymentRow): number | null;
30
+ export declare function triggerInfo(dep: DeploymentRow): {
31
+ by: string;
32
+ source: string;
33
+ userId: string;
34
+ };
35
+ /** Shape one deployment row into the stable JSON view the CLI publishes. */
36
+ export declare function deploymentView(dep: DeploymentRow): Record<string, unknown>;
37
+ export declare function deploymentsListCommand(rawArgs: string[]): Promise<void>;
38
+ export declare function rollbackCommand(rawArgs: string[]): Promise<void>;
39
+ export declare function cancelCommand(rawArgs: string[]): Promise<void>;
@@ -0,0 +1 @@
1
+ export declare function domainsCommand(action: string | undefined, rawArgs: string[]): Promise<void>;
@@ -0,0 +1,6 @@
1
+ export declare function envCommand(action: string | undefined, rawArgs: string[]): Promise<void>;
2
+ /** Parse `KEY=VALUE` or `KEY VALUE` from the positional operands. */
3
+ export declare function parseEnvAssignment(operands: string[]): {
4
+ key: string;
5
+ value: string;
6
+ } | null;
@@ -0,0 +1,3 @@
1
+ /** The identifier CREATE EXTENSION takes. `pgvector` is a common alias. */
2
+ export declare function resolveExtensionAlias(name: string): string;
3
+ export declare function extensionsCommand(action: string | undefined, rawArgs: string[]): Promise<void>;
@@ -0,0 +1 @@
1
+ export declare function cloudCommand(subcommand: string | undefined, rawArgs: string[]): Promise<void>;
@@ -0,0 +1,5 @@
1
+ export declare function linkCommand(rawArgs: string[]): Promise<void>;
2
+ export declare function unlinkCommand(): void;
3
+ export declare function selectOrgCommand(rawArgs: string[]): Promise<void>;
4
+ /** Open the Rebase Cloud dashboard (or the linked project) in a browser. */
5
+ export declare function openCommand(rawArgs: string[]): void;
@@ -0,0 +1 @@
1
+ export declare function orgsCommand(subcommand: string | undefined, rawArgs: string[]): Promise<void>;
@@ -0,0 +1,4 @@
1
+ type PowerAction = "start" | "stop" | "restart";
2
+ export declare function powerCommand(action: PowerAction, rawArgs: string[]): Promise<void>;
3
+ export declare function isPowerAction(v: string | undefined): v is PowerAction;
4
+ export {};
@@ -0,0 +1,13 @@
1
+ import { type CloudClient } from "./context";
2
+ export declare function listProjects(rawArgs: string[]): Promise<void>;
3
+ export declare function createProject(rawArgs: string[]): Promise<void>;
4
+ export declare function projectInfo(rawArgs: string[], projectRef: string): Promise<void>;
5
+ export declare function deleteProject(rawArgs: string[], projectRef: string): Promise<void>;
6
+ export declare function firstRow(client: CloudClient, collection: string, projectId: string): Promise<Record<string, unknown> | undefined>;
7
+ export declare function latestDeployment(client: CloudClient, projectId: string): Promise<{
8
+ id: string | number;
9
+ status?: string;
10
+ createdAt?: string;
11
+ logs?: string;
12
+ } | undefined>;
13
+ export declare function fmtDate(value: string | undefined): string;
@@ -0,0 +1,6 @@
1
+ export declare function statusCommand(rawArgs: string[]): Promise<void>;
2
+ export declare function metricsCommand(rawArgs: string[]): Promise<void>;
3
+ export declare function webhooksCommand(subcommand: string | undefined, rawArgs: string[]): Promise<void>;
4
+ export declare function storageCommand(rawArgs: string[]): Promise<void>;
5
+ export declare function clustersCommand(rawArgs: string[]): Promise<void>;
6
+ export declare function billingCommand(rawArgs: string[]): Promise<void>;
@@ -0,0 +1,8 @@
1
+ export declare function settingsCommand(action: string | undefined, rawArgs: string[]): Promise<void>;
2
+ /** Build the update patch from the flags actually supplied (pure/testable). */
3
+ export declare function buildSettingsPatch(args: {
4
+ name?: string;
5
+ subdomain?: string;
6
+ repo?: string;
7
+ branch?: string;
8
+ }): Record<string, string>;
@@ -1,5 +1,19 @@
1
1
  import type { PackageManager, PMCommands } from "../utils/package-manager";
2
+ /** Returns an error message, or null when the name is a valid package name. */
3
+ export declare function validateProjectName(name: string): string | null;
2
4
  export type TemplatePreset = "blog" | "ecommerce" | "blank";
5
+ /**
6
+ * How much of Rebase to scaffold.
7
+ *
8
+ * `cms` is the full triad (config + backend + frontend). `baas` is the backend
9
+ * alone, serving the database over REST with no collection files and no UI.
10
+ */
11
+ /**
12
+ * `cms` scaffolds BaaS + the admin UI; `baas` scaffolds the API alone. The
13
+ * values match `RebaseBackendConfig.mode`, which is what the generated backend
14
+ * sets — the labels below are what users actually read.
15
+ */
16
+ export type TemplateFlavor = "cms" | "baas";
3
17
  export interface InitOptions {
4
18
  projectName: string;
5
19
  git: boolean;
@@ -10,14 +24,23 @@ export interface InitOptions {
10
24
  introspect?: boolean;
11
25
  /** Starter template preset. */
12
26
  preset: TemplatePreset;
27
+ /** Which parts of Rebase to scaffold. */
28
+ flavor: TemplateFlavor;
13
29
  /** Detected package manager (pnpm or npm). */
14
30
  pm: PackageManager;
15
31
  /** Command helpers for the detected PM. */
16
32
  pmCommands: PMCommands;
33
+ /** Cloud project slug (its subdomain) to link the scaffold to. */
34
+ cloudProject?: string;
35
+ /** One-time setup key that authenticates the cloud link. */
36
+ setupKey?: string;
37
+ /** Control-plane URL the setup key is redeemed against. */
38
+ cloudUrl?: string;
17
39
  }
18
40
  export interface BuildQuestionsParams {
19
41
  nameArg?: string;
20
42
  templateArg?: TemplatePreset;
43
+ flavorArg?: TemplateFlavor;
21
44
  hasGitFlag: boolean;
22
45
  hasInstallFlag: boolean;
23
46
  pm: PackageManager;
@@ -1 +1 @@
1
- export declare function skillsCommand(subcommand: string | undefined, _args: string[]): Promise<void>;
1
+ export declare function skillsCommand(subcommand: string | undefined, rawArgs: string[]): Promise<void>;
package/dist/index.d.ts CHANGED
@@ -8,5 +8,6 @@ export * from "./commands/start";
8
8
  export * from "./commands/auth";
9
9
  export * from "./commands/doctor";
10
10
  export * from "./commands/generate_sdk";
11
+ export * from "./commands/cloud";
11
12
  export * from "./utils/project";
12
13
  export * from "./utils/package-manager";