Skip to content
xlsftPublic

About

The friend who knows everything. Ask how to do anything — Companion watches your screen with you and guides you step by step.

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

Companion: the friend who knows everything

Latest release CI License: FSL-1.1-ALv2

The friend who knows everything. Ask how to do anything. Companion watches your screen with you and guides you step by step.

  • Just ask out loud. Press a key, ask about whatever is in front of you, and hear the answer.
  • It shows you where to click. A ring and a pointer appear right over the button you need.
  • Private. Your voice stays on your computer, you use your own AI key, and there is no account.

Install

curl -fsSL https://raw.githubusercontent.com/xlsft/companion/main/install.sh | sh

Or with Homebrew: brew install xlsft/tap/companion, or download the latest release.

Runs on Linux today; Windows and macOS are on the way. Start Companion from your menu, follow the short setup, then press Super+Space and ask.

What it does

Asked how to add a sphere in Blender, Companion circles the Add menu and labels it: Add, Mesh, UV Sphere

  • Talk or type. Hold the key and speak, or write in the chat window. Interrupt the answer any time.
  • Step by step. For longer tasks it walks you through one step at a time and waits until you are ready.
  • Looks only when you ask. One picture of the screen at the moment of your question, never a recording.
  • Speaks your language. 13 languages, light and dark look.

Companion's hint over Blender in front, its chat and step-by-step guide windows behind

Questions

Is it free? Yes. You pay only your AI provider for what you use, or nothing at all with a model running on your own computer.

Which AI can I use? Anthropic (Claude), OpenAI and compatible services, or local models through Ollama or LM Studio. You paste your own key once; it is kept in your system's keychain.

Does my voice leave my computer? No. Speech is turned into text on your computer. Only the text of your question, and the one picture of your screen, go to the AI you chose. Details in SECURITY.md.

Which languages? The interface comes in 13 languages, and you can speak to it in yours.


Build from source · Linux details · Security and verifying downloads · Contributing

Licensed under FSL-1.1-ALv2: free to use, and each release becomes Apache 2.0 two years after it ships.

About

The friend who knows everything. Ask how to do anything — Companion watches your screen with you and guides you step by step.

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages