Using our CLI you can deploy and manage workflows without interacting with our UI. This is great for managing your workflows as code using CI/CD — you can store workflow configuration directly within your version control repo.
You can install the CLI on any platform by running the following code:
curl -sfL https://raw.githubusercontent.com/inngest/inngestctl/main/install.sh | sh
As always, you might want to inspect the shell code before running it. This line downloads the
latest binaries for your architecture from our releases
page into your current working directory. You'll want to move them into your
$PATH to use them
from any location.
You can also download the binaries manually, or build from source if you have go installed.
With the CLI installed, you should be able to run
inngestctl and show the available commands:
user@machine % inngestctlA serverless event-driven infrastructure platformUsage:inngest [command]Available Commands:actions Manages actions within your accounthelp Help about any commandlogin Logs in to your Inngest accountworkflows Manages workflows within your Inngest accountworkspaces Manages workspacess within your Inngest accountFlags:-h, --help help for inngest-l, --log.level string Log level (default "debug")--log.type string Log type (one of json, tty). Defaults to 'json' without a TTYUse "inngest [command] --help" for more information about a command.
After you've edited your workflow code locally you can verify that your workflow config is valid by running:
inngestctl workflows validate ./path-to-config.cue
If the workflow looks good, you can push the workflow without publishing with the following command:
inngestctl workflows deploy ./path-to-config.cue
If you want to push the workflow live, you can run the same command with the live flag:
inngestctl workflows deploy --live ./path-to-config.cue
That's it; your workflows will be deployed and will run without doing anything further.