@corsair-dev/cli 0.1.1

package/LICENSE

@@ -0,0 +1,191 @@
+  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 
+      (which shall not include Communications that are clearly marked or
+      otherwise designated in writing by the copyright owner as "Not a Work").
+
+      "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
+
+   Copyright (c) 2026 Corsair
+
+   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/README.md

@@ -0,0 +1,227 @@
+# @corsair-ai/cli
+
+The Corsair CLI handles everything needed to get a Corsair instance running: database setup, credential storage, and OAuth token acquisition. The intention is that a developer (or an agent) can go from a blank project to a fully authorized integration with a minimal number of commands, without ever needing to manually touch a database or manage encryption keys.
+
+All output is JSON, so both humans and agents can consume it the same way.
+
+---
+
+## Installation
+
+The CLI is included when you install `corsair`:
+
+```bash
+pnpm add corsair @corsair-ai/cli
+```
+
+The `corsair` binary is available immediately after install via `pnpm exec corsair <command>` or `npx corsair <command>`. No additional configuration needed.
+
+---
+
+## Commands
+
+### `corsair setup`
+
+Initializes your Corsair instance. Run this once after adding Corsair to your project, and again whenever you add new plugins.
+
+What it does:
+1. Verifies all required database tables exist
+2. Creates integration and account rows for each plugin
+3. Generates and stores Data Encryption Keys (DEKs)
+4. Reports which credentials are missing and how to set them
+
+```bash
+npx corsair setup
+```
+
+You can pass credentials inline to skip the manual step afterward:
+
+```bash
+npx corsair setup --slack api_key=xoxb-... --linear api_key=lin_api_...
+```
+
+Multiple plugins and fields can be set in one command:
+
+```bash
+npx corsair setup \
+  --slack api_key=xoxb-... \
+  --gmail client_id=... client_secret=...
+```
+
+#### Flags
+
+| Flag | Description |
+|------|-------------|
+| `--<plugin> <field>=<value>` | Set one or more credentials for a plugin |
+| `--backfill` | After setup, run list endpoints to pull initial data into the database |
+
+---
+
+### `corsair auth`
+
+Handles OAuth token acquisition. For plugins that use `oauth_2`, this command drives the full authorization flow and saves the resulting tokens.
+
+All output is JSON. The command never opens an interactive prompt.
+
+#### Get an OAuth URL
+
+```bash
+npx corsair auth --plugin=gmail
+```
+
+For providers that support localhost redirects (Google, etc.), the CLI starts a local server, outputs the auth URL, and waits. Once the user authorizes in the browser, the callback is captured and tokens are saved automatically:
+
+```json
+{ "status": "pending_oauth", "authUrl": "https://accounts.google.com/...", "redirectUri": "http://localhost:54321", "plugin": "gmail", "tenant": "default", "note": "Open authUrl in a browser. Tokens will be saved automatically once authorized." }
+```
+
+For providers that require a pre-registered redirect URI (Spotify, etc.), the URL is returned and the user must paste the code back manually:
+
+```json
+{ "status": "needs_code", "authUrl": "https://accounts.spotify.com/...", "redirectUri": "https://your-app.com/callback", "plugin": "spotify", "tenant": "default", "note": "Open authUrl, complete auth, then run: corsair auth --plugin=<id> --code=CODE" }
+```
+
+#### Exchange a code
+
+```bash
+npx corsair auth --plugin=spotify --code=AQD3...
+```
+
+```json
+{ "status": "success", "plugin": "spotify", "tenant": "default" }
+```
+
+#### Check current credentials
+
+```bash
+npx corsair auth --plugin=gmail --credentials
+```
+
+```json
+{
+  "plugin": "gmail",
+  "tenant": "default",
+  "credentials": {
+    "client_id": "12345....com",
+    "client_secret": "***",
+    "access_token": "ya29.A...abc",
+    "refresh_token": "1//0g...xyz",
+    "expires_at": "1234567890000"
+  }
+}
+```
+
+Values are masked in output (`first6...last3`).
+
+#### Flags
+
+| Flag | Description |
+|------|-------------|
+| `--plugin=<id>` | Required. The plugin to authorize |
+| `--tenant=<id>` | Tenant to authorize for. Defaults to `default` |
+| `--code=<code>` | Exchange an authorization code for tokens directly |
+| `--credentials` | Print current credential status instead of starting the OAuth flow |
+
+---
+
+### `corsair watch-renew`
+
+Renews Google webhook watch subscriptions (Gmail, Drive, Calendar). Google watch subscriptions expire after 7 days — run this on a schedule to keep them active.
+
+```bash
+npx corsair watch-renew
+```
+
+---
+
+## Typical setup flow
+
+### API key plugin (e.g. Slack, Linear)
+
+```bash
+# 1. Initialize
+npx corsair setup
+
+# 2. Set the credential (from setup output guidance, or inline)
+npx corsair setup --slack api_key=xoxb-...
+```
+
+### OAuth plugin (e.g. Gmail, Spotify)
+
+```bash
+# 1. Initialize and set OAuth app credentials
+npx corsair setup --gmail client_id=... client_secret=...
+
+# 2. Complete the OAuth flow
+npx corsair auth --plugin=gmail
+# → outputs auth URL, browser opens, tokens saved automatically
+```
+
+For providers with registered redirects:
+
+```bash
+npx corsair setup --spotify client_id=... client_secret=... redirect_url=https://your-app.com/callback
+npx corsair auth --plugin=spotify
+# → outputs auth URL + instructions
+npx corsair auth --plugin=spotify --code=AQD3...
+```
+
+---
+
+## Agent usage
+
+Because all output is JSON and no interactive prompts are used, the CLI is designed to be driven by an agent. A typical agent flow:
+
+```bash
+# Check what's missing
+npx corsair setup
+
+# Set credentials the agent obtained
+npx corsair setup --gmail client_id=... client_secret=...
+
+# Get the OAuth URL to show the user
+npx corsair auth --plugin=gmail
+# → parse authUrl from JSON, show to user or open browser
+
+# After user authorizes (for localhost-redirect providers, this is automatic)
+# For registered-redirect providers, exchange the code:
+npx corsair auth --plugin=gmail --code=<code from redirect>
+
+# Verify
+npx corsair auth --plugin=gmail --credentials
+```
+
+---
+
+## How credentials are stored
+
+Credentials are encrypted at rest using envelope encryption:
+
+- A Key Encryption Key (KEK) is provided by you via `CORSAIR_KEK` in your environment
+- Each plugin gets a Data Encryption Key (DEK) at the integration level (shared credentials like OAuth client ID/secret) and at the account level (per-tenant credentials like access tokens)
+- DEKs are encrypted with the KEK and stored in the database; individual fields are encrypted with the DEK
+
+The CLI manages DEK provisioning automatically during `setup` and `auth`. You only need to provide the KEK.
+
+---
+
+## Where the CLI looks for your `corsair.ts`
+
+The CLI searches these paths relative to your working directory:
+
+```
+corsair.ts / corsair.js
+src/corsair.ts
+src/server/corsair.ts
+server/corsair.ts
+lib/corsair.ts
+app/corsair.ts
+corsair/index.ts
+```
+
+Export your instance as a named export `corsair` or as the default export:
+
+```ts
+// src/server/corsair.ts
+export const corsair = createCorsair({ ... });
+```

package/dist/auth.d.ts

@@ -0,0 +1,10 @@
+export declare function runAuth({ cwd, pluginId: pluginIdArg, tenantId: tenantIdArg, code: codeArg, credentials: showCredentials, }: {
+    cwd: string;
+    pluginId?: string;
+    tenantId?: string;
+    /** OAuth authorization code to exchange for tokens. */
+    code?: string;
+    /** Output current credential status instead of starting OAuth flow. */
+    credentials?: boolean;
+}): Promise<void>;
+//# sourceMappingURL=auth.d.ts.map

package/dist/auth.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"auth.d.ts","sourceRoot":"","sources":["../auth.ts"],"names":[],"mappings":"AAucA,wBAAsB,OAAO,CAAC,EAC7B,GAAG,EACH,QAAQ,EAAE,WAAW,EACrB,QAAQ,EAAE,WAAW,EACrB,IAAI,EAAE,OAAO,EACb,WAAW,EAAE,eAAuB,GACpC,EAAE;IACF,GAAG,EAAE,MAAM,CAAC;IACZ,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,uDAAuD;IACvD,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,uEAAuE;IACvE,WAAW,CAAC,EAAE,OAAO,CAAC;CACtB,GAAG,OAAO,CAAC,IAAI,CAAC,CAmDhB"}

package/dist/get-tsconfig-info.d.ts

@@ -0,0 +1,2 @@
+export declare function getTsconfigInfo(cwd?: string, flatPath?: string): any;
+//# sourceMappingURL=get-tsconfig-info.d.ts.map

package/dist/get-tsconfig-info.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-tsconfig-info.d.ts","sourceRoot":"","sources":["../get-tsconfig-info.ts"],"names":[],"mappings":"AAWA,wBAAgB,eAAe,CAAC,GAAG,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,OAe9D"}

package/dist/index.d.ts

@@ -0,0 +1,33 @@
+/**
+ * Find the corsair config file path
+ */
+export declare function findCorsairConfigPath(cwd: string): string | null;
+/**
+ * Get the Corsair instance from the developer's codebase.
+ * Searches for corsair.ts in common locations and loads it using c12.
+ *
+ * @example
+ * ```ts
+ * const instance = await getCorsairInstance({
+ *   cwd: process.cwd(),
+ * });
+ *
+ * // For multi-tenant setups
+ * if ('withTenant' in instance) {
+ *   const tenant = instance.withTenant('tenant_123');
+ *   // Use tenant...
+ * }
+ * ```
+ *
+ * @param options - Configuration options
+ * @param options.cwd - Current working directory to search from
+ * @param options.configPath - Optional explicit path to corsair.ts file
+ * @param options.shouldThrowOnError - If true, throws errors instead of exiting process
+ * @returns The Corsair instance (CorsairClient or CorsairTenantWrapper)
+ */
+export declare function getCorsairInstance({ cwd, configPath, shouldThrowOnError, }: {
+    cwd: string;
+    configPath?: string;
+    shouldThrowOnError?: boolean;
+}): Promise<{}>;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAsLA;;GAEG;AACH,wBAAgB,qBAAqB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAQhE;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAsB,kBAAkB,CAAC,EACxC,GAAG,EACH,UAAU,EACV,kBAA0B,GAC1B,EAAE;IACF,GAAG,EAAE,MAAM,CAAC;IACZ,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,kBAAkB,CAAC,EAAE,OAAO,CAAC;CAC7B,eA2JA"}