Skip to main content
While Arakun is running, arakun <command> acts on the environment of the current folder. It talks to the app over a local control socket: $XDG_RUNTIME_DIR/arakun/control.sock, or %LOCALAPPDATA%\arakun\control.sock on Windows. Terminals and agents started by Arakun get ARAKUN_SOCKET and arakun on their PATH. The agents also get a note about it in their system prompt. Set ARAKUN_AGENT_HINT=off to remove that note.
Sandboxed agentsAn agent in a sandboxed project reaches Arakun through a socket of its own. That socket refuses arakun run, arakun agent and anything else that would act outside the sandbox.

Everyday commands

arakun rename works only before the branch is pushed. The folder keeps its name.

One Arakun at a time

Only arakun alone and arakun <dir> start the app. Run arakun again while it runs and it brings the window up instead. arakun <dir> adds that project to the running window. An Arakun with its own ARAKUN_STATE, such as arakun dev, has its own socket and its own arakun command. The command in your terminal keeps reaching your daily Arakun.

Help and mistakes

  • arakun --help lists every command.
  • -h or --help after a command prints its usage and runs nothing.
  • A command or flag it doesn’t know prints an error and exits with code 2.
  • Help and flags count only before the prompt, message or command line a command passes on. So arakun run make --help runs make --help.
  • A message that starts with a dash needs -- before it: arakun notify -- -1 test failed.
  • -s or --side shows a tab in the pane beside the active one.

Every command

Each group has a page of its own.
See Open pages and files, Read a terminal and Run the project check.
See Shrink command output and Fetch web pages.
arakun mem help lists the rest. See Memory.
See Headless agents.
github draft saves a review draft and sends nothing. See Leave a review draft. github pilot connects arakun-pilot, the pull request agent; arakun github pilot help lists its commands.
See Dynamic Island and Inbox.
A running Arakun installs the update when it quits. Nightly builds can break. See Server for arakun server help.arakun feedback takes bug, feature, ux or other, up to 4000 characters, or - to read stdin. Agents use it too. It needs usage telemetry on.

Without a running Arakun

These work with the app closed: arakun --version, arakun shrink, arakun fetch, arakun crawl, arakun mem, arakun island and headless agents.

Open the palette from anywhere

Bind arakun palette to a global key in your desktop. On Hyprland, for example:
hyprland.conf