All docs
Docs/The board/04

The orven command

What agents, and you, can do on a runner with orven.

What it's for

Every runner has an orven command. Agents use it to work the board the way you do: run processes, open previews, query databases, read a terminal, open columns. It works in any Terminal column too.

In Settings, Permissions, each part of it is Allowed or Asks each time. Typing into a terminal asks every time, whatever the setting.

Processes

  • orven proc add [--port N] <name> <command> adds a process and starts it. Adding the same name again replaces it.
  • orven proc ls lists the processes here and below.
  • orven proc logs [-f] <name> prints its output, and follows it with -f.
  • orven proc start, stop, restart and rm do what they say.

Previews

  • orven preview <process> --name N opens a process with a port, or orven preview --port N --name N a port, in a Browser column titled N; --path opens a page of it. It prints the dev server's address on Orven and who can open it.

Databases

  • orven db open opens a Database column, orven db tables lists tables, orven db describe <table> shows one.
  • orven db query '<sql>' runs a query, read-only.
  • orven db propose --why '<what>' '<sql>' puts a change in the column for you to approve.

The board

  • orven board ls lists the columns; --kind, --status needs, --grep, --idle 2h, --folded and --stacked list only those that match.
  • orven board read <column> reads one, like the screen of a terminal. --kind reply, --grep and --since 2h find what's further back in an agent's conversation.
  • orven board open <kind> opens a column of any kind the runner has, --on <runner> on another runner.
  • orven board send <column> <text> sends an agent a message; orven board type <column> <text> types into a terminal.
  • orven board rename and orven board close rename and close a column.
  • orven board fold, stack <column> <column> and unstack fold and stack columns, as the column menu does.
  • orven board boards lists your boards. orven board move <column> --on <runner> moves an agent to another runner with its conversation, and --dir <path> to another folder.

Later

  • orven wake in 20m <text>, at <time> and every <duration> wake the agent that runs it with a message, later. orven wake ls lists them, orven wake rm cancels one.
  • orven wait <command> runs something slow, a build or a deploy, and tells the agent when it ends, with its exit code and last lines.

Other runners

  • orven runners lists your runners, which are online and protected, and their load.
  • orven on <runner> -- <command> runs a command there, its arguments as given, as docker exec does; with no command, a shell. --here runs it in a copy of this workspace there.
  • orven fs ls|stat|cat <runner>:<path> looks at files there, orven cp <from> <to> copies them, and orven forward <runner>:<port> reaches a port there.

Diagrams and pages

  • orven show <kind> --title <title> draws a diagram or a chart in the agent's column. orven show help lists the kinds.
  • orven show page --title <title> shows an HTML page there.

Close the other windows.

Get ORVEN