Skip to content

Commit 49365ec

Browse files
committed
CLI readme edits
1 parent b3f4a73 commit 49365ec

File tree

1 file changed

+16
-43
lines changed

1 file changed

+16
-43
lines changed

packages/cli-v3/README.md

Lines changed: 16 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -6,46 +6,19 @@ Note: this only works with Trigger.dev v3 projects and later. For older projects
66

77
Trigger.dev is an open source platform that makes it easy to create event-driven background tasks directly in your existing project.
88

9-
## Usage
10-
11-
### Login
12-
13-
Logs that machine into Trigger.dev by creating a new Personal Access Token and storing it on the local machine. Once you're logged in you can perform the other actions below.
14-
15-
```sh
16-
npx trigger.dev@latest login
17-
```
18-
19-
| Option | Short option | Description |
20-
| ----------- | ------------ | -------------------------------------------------------------------- |
21-
| `--api-url` | `-a` | Set the API URL for Trigger.dev, defaults to https://api.trigger.dev |
22-
23-
### Update
24-
25-
Will update all of your @trigger.dev packages in your package.json to the latest version.
26-
27-
```sh
28-
npx trigger.dev@latest update
29-
```
30-
31-
You can pass the path to the folder that your package.json file lives in:
32-
33-
```sh
34-
npx trigger.dev@latest update ./myapp
35-
```
36-
37-
| Option | Short option | Description |
38-
| ------ | ------------ | ---------------------------------------------------------- |
39-
| `--to` | `-t` | The version to update to (ex: 2.1.4), defaults to "latest" |
40-
41-
### Who Am I?
42-
43-
Shows the current user that is logged in.
44-
45-
```sh
46-
npx trigger.dev@latest whoami
47-
```
48-
49-
| Option | Short option | Description |
50-
| ----------- | ------------ | -------------------------------------------------------------------- |
51-
| `--api-url` | `-a` | Set the API URL for Trigger.dev, defaults to https://api.trigger.dev |
9+
## Commands
10+
11+
| Command | Description |
12+
| :------------------------------------------------------------------- | :----------------------------------------------------------------- |
13+
| [login](https://trigger.dev/docs/cli-login-commands) | Login with Trigger.dev so you can perform authenticated actions. |
14+
| [init](https://trigger.dev/docs/cli-init-commands) | Initialize your existing project for development with Trigger.dev. |
15+
| [dev](https://trigger.dev/docs/cli-dev-commands) | Run your Trigger.dev tasks locally. |
16+
| [deploy](https://trigger.dev/docs/cli-deploy-commands) | Deploy your Trigger.dev v3 project to the cloud. |
17+
| [whoami](https://trigger.dev/docs/cli-whoami-commands) | Display the current logged in user and project details. |
18+
| [logout](https://trigger.dev/docs/cli-logout-commands) | Logout of Trigger.dev. |
19+
| [list-profiles](https://trigger.dev/docs/cli-list-profiles-commands) | List all of your CLI profiles. |
20+
| [update](https://trigger.dev/docs/cli-update-commands) | Updates all `@trigger.dev/*` packages to match the CLI version. |
21+
22+
## Support
23+
24+
If you have any questions, please reach out to us on [Discord](https://trigger.dev/discord) and we'll be happy to help.

0 commit comments

Comments
 (0)