github-featured/triggerdotdev--trigger.dev
2
0
Fork 0
Code Issues Pull Requests Deployments Models Agent Notes Packages Projects Releases Wiki Activity

Docs/more improvements (#1292)

Browse Source 
* WIP creating a CLI section

* WIP adding more CLI commands in a new section

* New CLI section with introduction and more CLI commands

* More improvement to the CLI options

* Each CLI command has its own page

* fixed broken links

* Removed outdated copy
This commit is contained in:
James Ritchie
2024-09-11 17:14:39 +01:00
committed by GitHub
parent 47ca24aab8
commit 972b5e34b8
18 changed files with 560 additions and 152 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/cli-introduction.mdx
+27
View File
@@ -0,0 +1,27 @@
---
title: "Introduction"
description: "The Trigger.dev CLI has a number of options and commands to help you develop locally, self host, and deploy your tasks."
---
## Standard options
<ParamField body="Help" type="--help | -h">
Displays a list of all help commands.
</ParamField>
<ParamField body="Version" type="--version | -v">
Displays the version number.
</ParamField>
## Commands
| Command | Description |
| :------------------------------------------------------- | :--------------------------------------------------------------------- |
| [Login](/cli-login-commands) | Login with Trigger.dev so you can perform authenticated actions. |
| [Init](/cli-init-commands) | Initialize your existing project for development with Trigger.dev. |
| [Dev](/cli-dev-commands) | Run your Trigger.dev tasks locally. |
| [Deploy](/cli-deploy-commands) | Deploy your Trigger.dev v3 project to the cloud. |
| [Whoami](/cli-whoami-commands) | Display the current logged in user and project details. |
| [Logout](/cli-logout-commands) | Logout of Trigger.dev. |
| [List-profiles](/cli-list-profiles-commands) | List all of your CLI profiles. |
| [Update](/cli-update-commands) | Updates all `@trigger.dev/*` packages to match the CLI version. |