Hub CLI

Setup

You can run it directly with bunx @windmill-labs/hub-cli or install it globally with npm install -g @windmill-labs/hub-cli in which case you can run it with wmill-hub.

Create a .env file in the root of the project with the following content:

# url of your private hub
HUB_URL=https://hub.my.url 

# to get a token, create a token for a superadmin user on your **Windmill instance**.
TOKEN=your_token 

Sync from private Hub

To sync from a private hub, run the following command:

wmill-hub pull

This will pull all the scripts from the private hub and save them in the hub folder.

Sync to private Hub

After editing your scripts, run the following command to push the changes to the private hub:

wmill-hub push

Create a new script locally

To create a new script locally, run the following command:

wmill-hub create --summary "My script summary" --language bun --kind action --app my_integration

or simply:

wmill-hub create -s "My script summary" -a my_integration

Language and kind are optional, they default to bun and action respectively.

You can then edit the script in the hub folder. Once you are done, you can push it to the private hub using the wmill-hub push command.

Sync from the official Hub

To sync from the official hub, run the following command:

wmill-hub wm-pull

You can then run wmill-hub push to push the scripts to your private hub. If you don't want all of them, delete the integrations you don't want before the first push. If you want to modify them, do it directly on the hub, not in the hub folder. To get the latest version of the official hub, run wmill-hub wm-pull again. It will not overwrite the imported scripts you modified on the hub.