orke employee instruct

Send an instruction. The next shift reads it and replies.

Command referenceEnglish

When to use it

Same as leaving an instruction in the UI's Inbox. The next shift reads it and replies in one line. --wake true means “Send and work now”.

Usage

Syntax · [ ] marks optional arguments
orke employee instruct --slug <string> --text <string> [--wake <boolean>]

Options

OptionsRequired?Value and description
--slugRequiredEmployee identifier (slug) returned by employee list. It may differ from the displayed name.
--textRequiredInstruction to send, up to 4,000 characters. Use --stdin to read from standard input instead.
--wakeOptionaltrue sends the instruction and starts a shift immediately (“Send and work now”). Defaults to false.

Common management options and errors →

Example

Terminal
orke employee instruct --slug employee_slug --text "Focus on blog posts this week" --json
orke employee instruct --slug employee_slug --text "Always include source links" --wake true --json

Replace employee_slug with the actual slug from employee list, and request_id with an actual id from get or inbox.

What to check in the result

EmployeeInstruction: slug · id (instruction id) · wake · phase

Behavior and states to watch

  • Use either --text or --stdin.
  • Instructions apply to every shift until a person changes them, rather than just one shift. Send a new instruction to change them.
  • Read the reply with orke employee inbox. When an instruction is included in a shift, a delivered row appears in the inbox (“Read” in the UI).
  • --wake true only works while work is enabled. Otherwise, it returns employee_not_running.
  • An empty instruction returns employee_instruction_empty; an overly long instruction returns employee_instruction_too_long.
  • This is a human (operator) command. Calls from an AI employee on shift are rejected with control_forbidden.

Search documentation

The page could not be displayed. Reload ×