|Docs

railway functions

Manage serverless functions in your Railway project.

Usage

railway functions <COMMAND> [OPTIONS]

Aliases

  • railway function
  • railway func
  • railway fn
  • railway funcs
  • railway fns

Subcommands

SubcommandAliasesDescription
listlsList functions
newcreate, addAdd a new function
deleteremove, rmDelete a function
pushup, deployPush changes to a function
pullPull changes from a linked function
linkLink a function manually

Examples

List functions

railway functions list

Create a new function

railway functions new --path ./my-function.ts --name my-function

Create an HTTP function

railway functions new --path ./api.ts --name api --http

Create a cron function

railway functions new --path ./job.ts --name cleanup --cron "0 * * * *"

Push changes

railway functions push

Push with watch mode

railway functions push --watch

Pull remote changes

railway functions pull

Delete a function

railway functions delete --function my-function
railway functions link --function my-function --path ./local-function.ts

Options for

FlagDescription
-p, --path <PATH>Path to the function file
-n, --name <NAME>Name of the function
-c, --cron <SCHEDULE>Cron schedule for the function
--httpGenerate a domain for HTTP access
-s, --serverlessEnable serverless mode (sleeping)
-w, --watchWatch for changes and deploy on save

Options for

FlagDescription
-p, --path <PATH>Path to the function
-w, --watchWatch for changes and deploy on save

Options for

FlagDescription
-f, --function <FUNCTION>ID or name of the function to delete
-y, --yesSkip confirmation dialog

Common options

FlagDescription
-e, --environment <ENV>Environment ID or name