3.0 KiB
name, description
| name | description |
|---|---|
| shsf | Interact with the users shsf instance to manage serverless functions, namespaces, triggers, schedules, and more via the CLI. |
SHSF - Selfhostable Serverless Functions; THE CLI
The shsf CLI tool allows you to interact with your shsf instance to manage serverless functions, namespaces, triggers, schedules, and more. Below are the available commands and their descriptions.
Setup
To get started, you need to set up the shsf CLI tool. Follow the instructions below to install and configure it.
- Run this
shsf health
this will check the health, and if not setup, it will prompt you to set up the CLI.
Commands
Count
-
shsf count functions: Count your functions. Add--fullto list them. -
shsf count namespaces: Count your namespaces. Add--fullto list them. -
shsf count storages: Count your storages. Add--fullto list them. -
shsf count triggers: Count your triggers. Add--fullto list them. -
shsf create function: Create a new function. (useshsf create function -hfirst) -
shsf create namespace: Create a new namespace. (useshsf create namespace -hfirst) -
shsf create trigger: Create a new trigger. (useshsf create trigger -hfirst) -
shsf delete function <id>: Deletes a specific serverless function by its ID. -
shsf delete namespace <id>: Deletes a namespace and all its functions by ID. -
shsf delete trigger <functionId> <triggerId>: Deletes a specific trigger from a function. -
shsf get function <id>: Get details of a specific function by its ID. -
shsf get namespace <id>: Get details of a specific namespace by its ID -
shsf get trigger <functionId> <triggerId>: Get details of a specific trigger from a function. -
shsf update function <id>: Update a specific serverless function by its ID. (useshsf update function -hfirst) -
shsf update namespace <id>: Update a specific namespace by its ID. (useshsf update namespace -hfirst) -
shsf update trigger <functionId> <triggerId>: Update a specific trigger from a function. (useshsf update trigger -hfirst) -
shsf file create: Create a file in a storage. (useshsf file create -hfirst) -
shsf file overwrite: Overwrite an existing file in a storage. (useshsf file overwrite -hfirst) -
shsf file delete: Delete a file from a storage. (useshsf file delete -hfirst) -
shsf file list: List files in a storage. (useshsf file list -hfirst)
Instructions
Use these commands for when you need to interact with shsf from the command line. Its faster than using the ui for almost all ops.
Update
Update with your package manager of choice. Preferably pnpm:
pnpm add -g shsf-cli
Note that new features are often released and a user might tell you to do things that are only in the latest version. So its a good idea to always keep it updated.
Missing a feature?
Features might be not documented yet, as this skill document rarely updates. Use the shsf -h command to see options and features.