From fd9a748553c0561815bece6cd4daeaedd73e7379 Mon Sep 17 00:00:00 2001 From: Eric Allam Date: Fri, 20 Sep 2024 16:12:14 +0100 Subject: [PATCH] Fixes #1337 - update docs for triggerdev -> trigger bin name change --- .vscode/launch.json | 12 ++++++------ CONTRIBUTING.md | 12 ++++++------ docs/upgrading-packages.mdx | 4 ++-- references/bun-catalog/README.md | 6 +++--- references/bun-catalog/package.json | 4 ++-- references/v3-catalog/README.md | 6 +++--- references/v3-catalog/package.json | 4 ++-- 7 files changed, 24 insertions(+), 24 deletions(-) diff --git a/.vscode/launch.json b/.vscode/launch.json index 8fd69a9b4..d70f6bdd9 100644 --- a/.vscode/launch.json +++ b/.vscode/launch.json @@ -24,7 +24,7 @@ "type": "node-terminal", "request": "launch", "name": "Debug V3 init CLI", - "command": "pnpm exec triggerdev init", + "command": "pnpm exec trigger init", "cwd": "${workspaceFolder}/references/init-shell", "sourceMaps": true }, @@ -32,7 +32,7 @@ "type": "node-terminal", "request": "launch", "name": "Debug V3 Dev CLI", - "command": "pnpm exec triggerdev dev", + "command": "pnpm exec trigger dev", "cwd": "${workspaceFolder}/references/v3-catalog", "sourceMaps": true }, @@ -48,7 +48,7 @@ "type": "node-terminal", "request": "launch", "name": "Debug V3 Deploy CLI", - "command": "pnpm exec triggerdev deploy --self-hosted --load-image", + "command": "pnpm exec trigger deploy --self-hosted --load-image", "cwd": "${workspaceFolder}/references/v3-catalog", "sourceMaps": true }, @@ -56,7 +56,7 @@ "type": "node-terminal", "request": "launch", "name": "Debug V3 list-profiles CLI", - "command": "pnpm exec triggerdev list-profiles --log-level debug", + "command": "pnpm exec trigger list-profiles --log-level debug", "cwd": "${workspaceFolder}/references/v3-catalog", "sourceMaps": true }, @@ -64,7 +64,7 @@ "type": "node-terminal", "request": "launch", "name": "Debug V3 update CLI", - "command": "pnpm exec triggerdev update", + "command": "pnpm exec trigger update", "cwd": "${workspaceFolder}/references/v3-catalog", "sourceMaps": true }, @@ -96,7 +96,7 @@ "type": "node-terminal", "request": "launch", "name": "debug v3 hello-world dev", - "command": "pnpm exec triggerdev dev", + "command": "pnpm exec trigger dev", "cwd": "${workspaceFolder}/references/hello-world", "sourceMaps": true } diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a5ca12fc1..c4fc0445e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -114,7 +114,7 @@ pnpm i ```sh cd references/v3-catalog cp .env.example .env -pnpm exec triggerdev login -a http://localhost:3030 +pnpm exec trigger login -a http://localhost:3030 ``` This will open a new browser window and authorize the CLI against your local user account. @@ -123,10 +123,10 @@ You can optionally pass a `--profile` flag to the `login` command, which will al ```sh cd references/v3-catalog -pnpm exec triggerdev login -a http://localhost:3030 --profile local +pnpm exec trigger login -a http://localhost:3030 --profile local # later when you run the dev or deploy command: -pnpm exec triggerdev dev --profile local -pnpm exec triggerdev deploy --profile local +pnpm exec trigger dev --profile local +pnpm exec trigger deploy --profile local ``` ### Running @@ -155,14 +155,14 @@ Note: You do not need to do the same for `@trigger.dev/sdk`, just core. ```sh # in /references/v3-catalog -pnpm exec triggerdev dev +pnpm exec trigger dev ``` If you want additional debug logging, you can use the `--log-level debug` flag: ```sh # in /references/v3-catalog -pnpm exec triggerdev dev --log-level debug +pnpm exec trigger dev --log-level debug ``` 5. If you make any changes in the CLI/Core/SDK, you'll need to `CTRL+C` to exit the `dev` command and restart it to pickup changes. Any changes to the files inside of the `v3-catalog/src/trigger` dir will automatically be rebuilt by the `dev` command. diff --git a/docs/upgrading-packages.mdx b/docs/upgrading-packages.mdx index 197c19f22..e2a84ad3a 100644 --- a/docs/upgrading-packages.mdx +++ b/docs/upgrading-packages.mdx @@ -71,8 +71,8 @@ But we recommend adding your dev and deploy commands to the `scripts` section of ```json { "scripts": { - "dev:trigger": "triggerdev dev", - "deploy:trigger": "triggerdev deploy" + "dev:trigger": "trigger dev", + "deploy:trigger": "trigger deploy" } } ``` diff --git a/references/bun-catalog/README.md b/references/bun-catalog/README.md index 37c0a04e9..b3e0768da 100644 --- a/references/bun-catalog/README.md +++ b/references/bun-catalog/README.md @@ -35,13 +35,13 @@ cd references/v3-catalog 4. If you've never logged in to the CLI you'll see an error telling you to login. Do this: ```bash -pnpm exec triggerdev login -a http://localhost:3030 +pnpm exec trigger login -a http://localhost:3030 ``` If this fails because you already are logged in you can create a new profile: ```bash -pnpm exec triggerdev login -a http://localhost:3030 --profile local +pnpm exec trigger login -a http://localhost:3030 --profile local ``` Note: if you use a profile then you'll need to append `--profile local` to all commands, like `dev`. @@ -49,7 +49,7 @@ Note: if you use a profile then you'll need to append `--profile local` to all c 5. Run the v3 CLI ```bash -pnpm exec triggerdev dev +pnpm exec trigger dev ``` 6. You should see the v3 dev command spitting out messages, including that it's started a background worker. diff --git a/references/bun-catalog/package.json b/references/bun-catalog/package.json index 653d5b2be..483cfe2c5 100644 --- a/references/bun-catalog/package.json +++ b/references/bun-catalog/package.json @@ -3,8 +3,8 @@ "private": true, "type": "module", "scripts": { - "dev:trigger": "triggerdev dev", - "deploy": "triggerdev deploy" + "dev:trigger": "trigger dev", + "deploy": "trigger deploy" }, "dependencies": { "@trigger.dev/sdk": "workspace:*" diff --git a/references/v3-catalog/README.md b/references/v3-catalog/README.md index 37c0a04e9..b3e0768da 100644 --- a/references/v3-catalog/README.md +++ b/references/v3-catalog/README.md @@ -35,13 +35,13 @@ cd references/v3-catalog 4. If you've never logged in to the CLI you'll see an error telling you to login. Do this: ```bash -pnpm exec triggerdev login -a http://localhost:3030 +pnpm exec trigger login -a http://localhost:3030 ``` If this fails because you already are logged in you can create a new profile: ```bash -pnpm exec triggerdev login -a http://localhost:3030 --profile local +pnpm exec trigger login -a http://localhost:3030 --profile local ``` Note: if you use a profile then you'll need to append `--profile local` to all commands, like `dev`. @@ -49,7 +49,7 @@ Note: if you use a profile then you'll need to append `--profile local` to all c 5. Run the v3 CLI ```bash -pnpm exec triggerdev dev +pnpm exec trigger dev ``` 6. You should see the v3 dev command spitting out messages, including that it's started a background worker. diff --git a/references/v3-catalog/package.json b/references/v3-catalog/package.json index fdbf5c09d..ff1c63c5d 100644 --- a/references/v3-catalog/package.json +++ b/references/v3-catalog/package.json @@ -6,8 +6,8 @@ "schema": "./prisma/schema.zmodel" }, "scripts": { - "dev:trigger": "triggerdev dev", - "deploy": "triggerdev deploy", + "dev:trigger": "trigger dev", + "deploy": "trigger deploy", "management": "ts-node -r dotenv/config -r tsconfig-paths/register ./src/management.ts", "queues": "ts-node -r dotenv/config -r tsconfig-paths/register ./src/queues.ts", "build:client": "tsup-node ./src/clientUsage.ts --format esm,cjs",