How to use jk/

From install to your first rewritten sentence in about two minutes.

  1. Install and launch

    Grab the build from the download page and run it. JKSlash sits quietly in the system tray, watching for the trigger.

  2. Add an API key

    Open the settings window from the tray icon and paste your key. It is stored in the Windows Credential Manager — never in a plain-text file. OpenAI is the default; Anthropic and any OpenAI-compatible endpoint work too. You can also set the JKSLASH_API_KEY environment variable to override.

  3. Type jk/ anywhere

    In any text field — a chat box, your editor, the browser address bar — type the trigger. From that moment your keystrokes are diverted into a small overlay window instead of the field.

  4. Write your prompt, hit Apply

    Edit the prompt in the overlay, press Apply, and JKSlash sends it through your configured agent (a system-prompt wrapper) to your configured LLM.

  5. The reply is typed back

    The model's answer is injected into the original field, exactly where your cursor was. Press Enter to send it like you typed it yourself.

Make the agent yours

The agent is a system-prompt wrapper around whatever you type. Want a translator, a tone-softener, a regex generator? Change the system prompt in config.toml and the same jk/ trigger becomes a different tool.

# %APPDATA%\JKSlash\config.toml
[llm]
provider = "openai"     # default — works as soon as a key is present
# provider = "anthropic" # Claude via the Anthropic API
# provider = "test"      # offline echo — verify the wiring without a key
endpoint = "https://api.openai.com/v1/chat/completions"
model    = "gpt-4o-mini"
keyring_account = "openai"
temperature = 0.7

Try it with no key at all

Set provider = "test" and JKSlash runs fully offline, echoing formatted by test: <your text> back into the field. Perfect for checking that the trigger, overlay and injection all work before you spend a token.

On macOS and Linux

The full overlay/injection pipeline currently targets Windows. On macOS and Linux the binary launches a terminal mode instead:

jkslash --cli

A REPL that runs the same configured agent and LLM, so you can validate your config and credentials while global input capture is on its way.