# work list

`receptorctl work list` displays known units of work

Command syntax: `receptorctl --socket=<socket_path> work list`

`socket_path` is the control socket address for the Receptor connection.

  The default is `unix:` for a Unix socket. Use `tcp://` for a TCP socket. The corresponding environment variable is `RECEPTORCTL_SOCKET`.

    ss --listening --processes --unix 'src = unix:<socket_path>'
    Netid         State          Recv-Q         Send-Q                   Local Address:Port                     Peer Address:Port        Process
    u_str         LISTEN         0              4096                   /tmp/local.sock 38130170                            * 0            users:(("receptor",pid=3226769,fd=7))

`ps -fp $(pidof receptor)` `lsof -p <pid>`

The output is divided into work unit sections listed below. Field values might be listed separately. Columns are the actual JSON node values.

## Work unit section

Work unit section
Column | Description
--- | ---
`."Work unit string"` | Random eight character work unit (job) string.
`."Work unit string"."Detail"` | Work unit output.
`."Work unit string"."ExtraData"` | Additional information added for specific worktypes.
`.""Work unit string"."State"` | Current state for the work unit (int).
`.""Work unit string"."StateName"` | Human-readable current state for the work unit.
`.""Work unit string"."StdoutSize"` | Size of the work unit output (bytes).
`.""Work unit string"."WorkType"` | Execution request type for the work unit.

## Work unit states

Work unit states
State | StateName | Description
--- | --- | ---
`0` | `Pending` | Work unit has not started.
`1` | `Running` | Work unit is currently executing.
`2` | `Succeeded` | Work unit completed without error.
`3` | `Failed` | Work unit encountered an error or unexpected condition and did not complete.
`4` | `Canceled` | Work unit was terminated externally.