Skip to main content
Use artil --version to check your installation and artil <command> --help for command syntax.

​
Authentication

See authentication.

​
Use the terminal menu

To browse your inbox without typing each command, run:
Choose Email or SMS to read, reply, or compose a message. Secrets stores credentials and links them to a client. Set up this machine connects Claude Code or Hermes. Status shows your login and channel setup. Use the arrow keys to move, Enter to choose, and Escape to go back. Press q or Ctrl-C to quit; q types a letter while you are entering text. Choose Email → Inbox, open a message, then press r to reply. Choose Compose from the Email or SMS menu to start a new message. Enter on the message-body field submits it. When you pipe artil into another command, it prints status instead of opening the menu. Explicit commands such as artil email list also keep their text output; use --json for scripts.

​
Client setup

Without an interactive terminal, pass --client to make a selection. Otherwise init prints the available connections without connecting one. See automatic delivery. For the Claude Code plugin or Pi extension, follow their installation guides; init does not install them. --client none removes local delivery setup and the selected agent’s remote Hermes webhook, including a webhook configured on another computer. See disconnect message delivery before running it.

​
Email and SMS

Personal SMS is in beta. Email founders@firaresearch.com to request access before using the SMS commands. The default list limit is 25; accepted values are 1 to 25. Use a listed message ID with read or --reply-to. See email and Personal SMS (beta) for channel-specific requirements. Pass each message body as one quoted argument. Put -- before a body that starts with a dash so it is read as message text.

​
Secrets

See secrets.

​
Updates

This updates a standalone installation. If you installed through a package manager, use that package manager to update. See installation.

​
Output and failures

--json is supported only by the commands listed above. It is a command flag, so put it after the relevant command. For example:
Successful email and SMS commands put message data inside result. Status and secret commands have their own JSON fields. secrets list --json shows secret names and update details; values and linked destinations are omitted. Failed commands exit with status 1. In text mode, errors appear on stderr. In JSON mode, message errors can appear on stdout and may have a different structure from successful results. Check the exit status before reading result. Unknown flags return an error.

​
Configuration

The default configuration directory is ~/.config/artil. credentials.json holds the login; config.json holds machine and OAuth registration state; secrets.json records local secret links.

​
Older command names

Older aliases and internal commands still work for existing client setups. Use the commands above for new scripts. tools, mcp, and sync are hidden from help, and sync must also be enabled on the Artil server.