@trayai/tray-sync-cli 0.0.1

package/LICENSE.md

@@ -0,0 +1,182 @@
+This license applies to the published `@trayai/tray-sync-cli` npm package
+(the contents of `dist/`). All other files in this repository remain
+Tray.ai, Inc. proprietary — all rights reserved.
+
+Copyright 2026 Tray.ai, Inc.
+
+                                 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

package/README.md

@@ -0,0 +1,167 @@
+# tray-sync-cli
+CLI tool to clone tray projects and related assets on local machine which then can be used with version control system or promoted to different tray environment
+
+## Requirements
+
+- Node.js >= 22
+
+## Install
+
+```bash
+npm install -g @trayai/tray-sync-cli
+```
+
+## Usage
+
+```bash
+tray --version
+tray --help
+```
+
+## Getting started: a first promotion, end to end
+
+This is a concrete, step-by-step walkthrough of the most common workflow: pull a project from a source workspace, and promote it to a target workspace. It uses a two-org example (`DEV_ORG` → `PROD_ORG`) since that's the realistic setup for most customer pipelines, but everything here works identically for two workspaces within the same org.
+
+### 1. Pick a source and a target environment
+
+Decide which workspace you're pulling *from* (the source) and which one you're promoting *to* (the target). For this guide:
+
+- Source: `DEV_ORG`
+- Target: `PROD_ORG`
+
+You'll need each workspace's ID and region, and a Tray API token with access to it.
+
+### 2. Create a local directory for this project
+
+```bash
+mkdir -p ~/tcli-projects/my-first-tcli-project
+cd ~/tcli-projects/my-first-tcli-project
+```
+
+Everything the CLI manages — `tray.yaml`, `environments.json`, and every pulled project — lives under this directory.
+
+### 3. Initialize the repository against your source workspace
+
+```bash
+tray init -r <region> -w <your-SOURCE-workspace-id> -t <your-token> -p <project-id-to-pull>
+```
+
+Example:
+
+```bash
+tray init -r us1 -w 11111111-1111-1111-1111-111111111111 -t <token> -p <project_id>
+```
+
+A few notes on the flags:
+
+- **`-p <project-id>`** pulls that project immediately after scaffolding. Omit it and `init` just scaffolds an empty repository — you can pull specific projects later with: `tray pull -p <project_id>` OR  `tray project add <project-id>` followed by `tray pull`. 
+- **`-s workspace`** (i.e. `tray init -s workspace -r <region> -w <id> -t <token>`, omitting `-p`) switches to workspace scope: every project in the workspace is pulled automatically, and `tray pull` keeps that mirror in sync going forward (including removing projects deleted from Tray). `-p` is ignored in this scope.
+- **`-t <token>`** is optional at `init` time. If you skip it (or need to replace it later — tokens expire), set or refresh it any time with:
+  ```bash
+  tray auth set -w <workspace-id> -r <region> -t <token>
+  ```
+  `tray auth set` always overwrites whatever token was stored for that workspace — no separate "force" flag needed.
+
+At this point you have a local mirror of your source project(s), configured against `DEV_ORG`.
+
+### 4. Add your target environment
+
+Now register where you want to promote *to*:
+
+```bash
+tray env add <env-name> -r <region> -w <target-workspace-id> -t <target-token>
+```
+
+Example:
+
+```bash
+tray env add PROD_ORG -r us1 -w 22222222-2222-2222-2222-222222222222 -t <prod-token>
+```
+
+You can add more than one target environment this way (e.g. `STAGING_ORG`, `PROD_ORG`) — each gets its own entry in `environments.json`.
+
+Same as `init`, providing `-t` here stores the token in `~/.tray/credentials.json` immediately. You can always set or refresh it independently with `tray auth set -w <target-workspace-id> -r <region> -t <token>`.
+
+### 5. Promote
+
+You're ready to import your local projects into the target environment. A few common invocations:
+
+```bash
+# Recommended first: see what would happen without changing anything.
+tray promote --to PROD_ORG --dry-run
+
+# Promote a single project.
+tray promote --to PROD_ORG -p <project-id>
+
+# Promote multiple specific projects.
+tray promote --to PROD_ORG -p <project-id-1> <project-id-2>
+
+# Promote every project tracked in this directory (see them with `tray project list`).
+tray promote --to PROD_ORG
+```
+
+### Important: every project needs a `target_project_id` per environment
+
+The first time you promote a given project to a given environment — or whenever the target project changes — you need to tell the CLI which project in the target workspace this should import into.
+
+Each pulled project has its own `mappings.json`, at:
+
+```
+projects/<project-id>--<project-name>/mappings.json
+```
+
+You don't have to create this file by hand — `tray pull` / `tray init` already scaffold it for you (with a placeholder entry showing the full shape) the first time a project is pulled. What you do need to do is edit the target environment's entry and fill in the real `target_project_id`:
+
+```json
+{
+  "version": 1,
+  "environments": {
+    "PROD_ORG": {
+      "target_project_id": "<project-id>",
+      "authentications": {},
+      "config": {},
+      "connectors": [],
+      "services": []
+    }
+  }
+}
+```
+
+`target_project_id` here is the ID of the project **in `PROD_ORG`** that this local project should be imported into.
+
+#### Authentications
+
+If any workflow in the project you're promoting uses an authentication, you'll also need to map it. Tray tracks this per **authentication group** — a logical "auth slot" a workflow step references — not the authentication ID itself. When `tray promote` finds one it doesn't recognize, it tells you and scaffolds a placeholder into `mappings.json` for you:
+
+```json
+{
+  "version": 1,
+  "environments": {
+    "PROD_ORG": {
+      "target_project_id": "<project-id>",
+      "authentications": {
+        "<source_authentication_id>": "MISSING_TARGET_AUTHENTICATION"
+      },
+      "config": {},
+      "connectors": [],
+      "services": []
+    }
+  }
+}
+```
+
+The key (`<source_authentication_id>`) is the source-side auth group ID — leave it as-is. Replace the placeholder value with the ID of the actual authentication in your **target** environment (`PROD_ORG`) that should serve that slot — you can find this in Tray's app, under that workspace's authentications. For example:
+
+```json
+"authentications": {
+  "<source_authentication_id>": "<resolved_target_authentication_id>"
+}
+```
+
+#### If you get it wrong
+
+If a required field is missing or still holds a placeholder value, `tray promote` refuses the attempt and tells you exactly what's outstanding and where to fix it — it won't silently promote a project into the wrong target, or with an unresolved authentication.
+
+## Contributing
+
+For local development setup, the smoke/integration test, and internal architecture notes, see the "For contributors to this repo" section in [docs/getting-started-guide.md](docs/getting-started-guide.md#for-contributors-to-this-repo).

package/dist/api/errors.js

@@ -0,0 +1,29 @@
+export class TrayApiError extends Error {
+}
+export class AuthError extends TrayApiError {
+}
+export class NotFoundError extends TrayApiError {
+}
+export class RateLimitError extends TrayApiError {
+}
+export class NetworkError extends TrayApiError {
+}
+export class IncompatibleApiError extends TrayApiError {
+    constructor(message) {
+        super(`${message} — try upgrading tray-sync-cli.`);
+    }
+}
+export function errorForStatus(status, body) {
+    switch (status) {
+        case 401:
+        case 403:
+            return new AuthError(`Authentication failed (HTTP ${status}): ${body}`);
+        case 404:
+            return new NotFoundError(`Not found (HTTP ${status}): ${body}`);
+        case 429:
+            return new RateLimitError(`Rate limited (HTTP ${status}): ${body}`);
+        default:
+            return new NetworkError(`Request failed (HTTP ${status}): ${body}`);
+    }
+}
+//# sourceMappingURL=errors.js.map

package/dist/api/trayClient.js

@@ -0,0 +1,69 @@
+import { isAllowedUrl, urlsForRegion } from "../lib/region.js";
+import { errorForStatus, IncompatibleApiError, NetworkError } from "./errors.js";
+const DEFAULT_TIMEOUT_MS = 30_000;
+export function createTrayClientForRegion(region, token, options) {
+    const { apiBaseUrl, graphqlUrl } = urlsForRegion(region);
+    for (const url of [apiBaseUrl, graphqlUrl]) {
+        if (!isAllowedUrl(url)) {
+            throw new NetworkError(`URL is not in the allowlist: ${url}`);
+        }
+    }
+    return new TrayClient({ apiBaseUrl, graphqlUrl, token, ...options });
+}
+export class TrayClient {
+    apiBaseUrl;
+    graphqlUrl;
+    token;
+    timeoutMs;
+    fetchImpl;
+    isAllowedUrlImpl;
+    constructor(options) {
+        this.apiBaseUrl = options.apiBaseUrl;
+        this.graphqlUrl = options.graphqlUrl;
+        this.token = options.token;
+        this.timeoutMs = options.timeoutMs ?? DEFAULT_TIMEOUT_MS;
+        this.fetchImpl = options.fetchImpl ?? fetch;
+        this.isAllowedUrlImpl = options.isAllowedUrlImpl ?? isAllowedUrl;
+    }
+    async request(method, path, body) {
+        return this.fetchJson(`${this.apiBaseUrl}${path}`, method, body);
+    }
+    async graphql(query, variables, url = this.graphqlUrl) {
+        const result = (await this.fetchJson(url, "POST", { query, variables }));
+        if (result.errors && result.errors.length > 0) {
+            throw new IncompatibleApiError(`GraphQL errors: ${JSON.stringify(result.errors)}`);
+        }
+        return result.data;
+    }
+    async fetchJson(url, method, body) {
+        if (!this.isAllowedUrlImpl(url)) {
+            throw new NetworkError(`URL is not in the allowlist: ${url}`);
+        }
+        let response;
+        try {
+            response = await this.fetchImpl(url, {
+                method,
+                headers: {
+                    Authorization: `Bearer ${this.token}`,
+                    "Content-Type": "application/json",
+                },
+                body: body === undefined ? undefined : JSON.stringify(body),
+                signal: AbortSignal.timeout(this.timeoutMs),
+            });
+        }
+        catch (err) {
+            throw new NetworkError(`Request to ${url} failed: ${err.message}`);
+        }
+        const text = await response.text();
+        if (!response.ok) {
+            throw errorForStatus(response.status, text);
+        }
+        try {
+            return text === "" ? undefined : JSON.parse(text);
+        }
+        catch {
+            throw new IncompatibleApiError(`Could not parse response from ${url}`);
+        }
+    }
+}
+//# sourceMappingURL=trayClient.js.map

package/dist/cli.js

@@ -0,0 +1,32 @@
+#!/usr/bin/env node
+import { Command } from "commander";
+import { readFileSync } from "node:fs";
+import { fileURLToPath } from "node:url";
+import path from "node:path";
+import { initCommand } from "./commands/init.js";
+import { pullCommand } from "./commands/pull.js";
+import { statusCommand } from "./commands/status.js";
+import { projectCommand } from "./commands/project.js";
+import { envCommand } from "./commands/env.js";
+import { authCommand } from "./commands/auth.js";
+import { promoteCommand } from "./commands/promote.js";
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
+const pkg = JSON.parse(readFileSync(path.join(__dirname, "..", "package.json"), "utf8"));
+const program = new Command();
+program
+    .name("tray")
+    .description("Mirror Tray projects to local files and promote them between Tray environments")
+    .version(pkg.version, "-v, --version");
+program.addCommand(initCommand);
+program.addCommand(pullCommand);
+program.addCommand(statusCommand);
+program.addCommand(projectCommand);
+program.addCommand(envCommand);
+program.addCommand(authCommand);
+program.addCommand(promoteCommand);
+program.parseAsync(process.argv).catch((err) => {
+    const message = err instanceof Error ? err.message : String(err);
+    console.error(message);
+    process.exitCode = 1;
+});
+//# sourceMappingURL=cli.js.map

package/dist/commands/auth.js

@@ -0,0 +1,103 @@
+import { Command, InvalidArgumentError } from "commander";
+import { readCredentials, writeCredentials } from "../config/credentials.js";
+import { describeRegion } from "../lib/regionDisplay.js";
+import { parseRegion } from "../lib/regionParsing.js";
+import { isUuid } from "../lib/uuid.js";
+export function printAuthSetResult(stdout, result) {
+    const verb = result.overwrote ? "Updated" : "Set";
+    stdout(`${verb} token for workspace ${result.workspaceId} (${describeRegion(result.region)}).`);
+}
+export async function runAuthSet(deps, options) {
+    const { env, stdout } = deps;
+    const credentials = await readCredentials(env);
+    const overwrote = credentials.workspaces[options.workspaceId] !== undefined;
+    credentials.workspaces[options.workspaceId] = {
+        region: options.region,
+        token: options.token,
+    };
+    await writeCredentials(credentials, env);
+    printAuthSetResult(stdout, { workspaceId: options.workspaceId, region: options.region, overwrote });
+    return 0;
+}
+export function printAuthRemoveResult(stdout, result) {
+    if (!result.removed) {
+        stdout(`No stored credentials for workspace ${result.workspaceId}. Nothing to remove.`);
+        return;
+    }
+    stdout(`Removed stored credentials for workspace ${result.workspaceId}.`);
+}
+export async function runAuthRemove(deps, options) {
+    const { env, stdout } = deps;
+    const credentials = await readCredentials(env);
+    const removed = credentials.workspaces[options.workspaceId] !== undefined;
+    if (removed) {
+        delete credentials.workspaces[options.workspaceId];
+        await writeCredentials(credentials, env);
+    }
+    printAuthRemoveResult(stdout, { workspaceId: options.workspaceId, removed });
+    return 0;
+}
+export function printAuthListResult(stdout, result) {
+    if (result.entries.length === 0) {
+        stdout("No stored credentials.");
+        return;
+    }
+    for (const entry of result.entries) {
+        stdout(`  ${entry.workspaceId} (${describeRegion(entry.region)})`);
+    }
+}
+export async function runAuthList(deps, _options) {
+    const { env, stdout } = deps;
+    const credentials = await readCredentials(env);
+    const entries = Object.entries(credentials.workspaces)
+        .map(([workspaceId, entry]) => ({ workspaceId, region: entry.region }))
+        .sort((a, b) => a.workspaceId.localeCompare(b.workspaceId));
+    printAuthListResult(stdout, { entries });
+    return 0;
+}
+function parseUuid(value, flagName) {
+    if (!isUuid(value)) {
+        throw new InvalidArgumentError(`${flagName} must be a UUID`);
+    }
+    return value;
+}
+function realDeps() {
+    return {
+        env: process.env,
+        stdout: (line) => console.log(line),
+        stderr: (line) => console.error(line),
+    };
+}
+export const authCommand = new Command("auth").description("Manage ~/.tray/credentials.json directly, independent of tray env");
+authCommand
+    .command("set")
+    .description("Set (or overwrite) a workspace's token")
+    .requiredOption("-w, --workspace-id <id>", "Tray workspace UUID", (value) => parseUuid(value, "--workspace-id"))
+    .requiredOption("-r, --region <region>", "Tray region this workspace lives in", parseRegion)
+    .requiredOption("-t, --token <token>", "Tray API token to store")
+    .action(async (opts) => {
+    const exitCode = await runAuthSet(realDeps(), {
+        workspaceId: opts.workspaceId,
+        region: opts.region,
+        token: opts.token,
+    });
+    process.exitCode = exitCode;
+});
+authCommand
+    .command("remove")
+    .description("Remove a workspace's stored token")
+    .requiredOption("-w, --workspace-id <id>", "Tray workspace UUID", (value) => parseUuid(value, "--workspace-id"))
+    .action(async (opts) => {
+    const exitCode = await runAuthRemove(realDeps(), {
+        workspaceId: opts.workspaceId,
+    });
+    process.exitCode = exitCode;
+});
+authCommand
+    .command("list")
+    .description("List workspaces with stored credentials")
+    .action(async () => {
+    const exitCode = await runAuthList(realDeps(), {});
+    process.exitCode = exitCode;
+});
+//# sourceMappingURL=auth.js.map