Skip to content
View as Markdown

Function Commands

Commands for managing function registries and viewing function execution logs.

function

Manage functions

Usage

tailor function [command]

See Global Options for options available to all commands.

Commands

CommandDescription
function getGet a function registry by name
function listList function registries in a workspace
function logsList or get function execution logs.
function test-runRun a function on the Tailor Platform server without deploying.

function get

Get a function registry by name

Usage

tailor function get [options]

Options

OptionAliasDescriptionRequiredDefaultEnv
--workspace-id <WORKSPACE_ID>-wWorkspace IDNo-TAILOR_PLATFORM_WORKSPACE_ID
--profile <PROFILE>-pWorkspace profileNo-TAILOR_PLATFORM_PROFILE
--name <NAME>-nFunction nameYes--

See Global Options for options available to all commands.

function list

List function registries in a workspace

Usage

tailor function list [options]

Options

OptionAliasDescriptionRequiredDefaultEnv
--workspace-id <WORKSPACE_ID>-wWorkspace IDNo-TAILOR_PLATFORM_WORKSPACE_ID
--profile <PROFILE>-pWorkspace profileNo-TAILOR_PLATFORM_PROFILE
--order <ORDER>-Sort order (asc or desc)No"desc"-
--limit <LIMIT>-lMaximum number of items to return (0 or omit: unlimited)No--

See Global Options for options available to all commands.

function logs

List or get function execution logs.

Usage

tailor function logs [options] [execution-id]

Arguments

ArgumentDescriptionRequired
execution-idExecution ID (if provided, shows details with logs)No

Options

OptionAliasDescriptionRequiredDefaultEnv
--workspace-id <WORKSPACE_ID>-wWorkspace IDNo-TAILOR_PLATFORM_WORKSPACE_ID
--profile <PROFILE>-pWorkspace profileNo-TAILOR_PLATFORM_PROFILE
--order <ORDER>-Sort order (asc or desc)No"desc"-
--limit <LIMIT>-lMaximum number of items to return (0: unlimited)No50-

See Global Options for options available to all commands.

Examples

List all function execution logs

bash
$ tailor function logs

Get execution details with logs

bash
$ tailor function logs <execution-id>

Output as JSON

bash
$ tailor function logs --json

Get execution details as JSON

bash
$ tailor function logs <execution-id> --json

Notes

When viewing a specific execution that failed, the command displays error details with the stack trace mapped back to your original source files (clickable file links and code snippets, matching function test-run output).

Stack traces are mapped only when the execution includes a content hash for the exact build that ran. If the content hash is missing or the build is no longer available, the command falls back to a plain-text error display.

function test-run

Run a function on the Tailor Platform server without deploying.

Usage

tailor function test-run [options] <file>

Arguments

ArgumentDescriptionRequired
filePath to the function fileYes

Options

OptionAliasDescriptionRequiredDefaultEnv
--workspace-id <WORKSPACE_ID>-wWorkspace IDNo-TAILOR_PLATFORM_WORKSPACE_ID
--profile <PROFILE>-pWorkspace profileNo-TAILOR_PLATFORM_PROFILE
--name <NAME>-nWorkflow job name to run (matches the name field of createWorkflowJob)No--
--arg <ARG>-aJSON argument to pass to the functionNo--
--machine-user <MACHINE_USER>-mMachine user name for authentication. Falls back to the active profile's default machine user.No-TAILOR_PLATFORM_MACHINE_USER_NAME
--config <CONFIG>-cPath to SDK config fileNo"tailor.config.ts"-

See Global Options for options available to all commands.

Examples

Run a resolver with input arguments

bash
$ tailor function test-run resolvers/add.ts --arg '{"a":1,"b":2}'

Run a specific workflow job by name

bash
$ tailor function test-run workflows/sample.ts --name validate-order

Run a pre-bundled .js file directly

bash
$ tailor function test-run build/resolvers/add.js --arg '{"a":1,"b":2}'

Notes

You can pass either a source file (.ts) or a pre-bundled file (.js). When a .js file is provided, detection and bundling are skipped and the file is executed as-is.

WARNING

Workflow job .start() calls do not work in test-run mode. Started jobs are not executed; only the target job's body function runs in isolation.