Skip to main content

Getting Started

This guide walks through launching Maekon for the first time, confirming the local dashboard, and deciding whether an optional organization connection is in scope.

1. Launch Maekon​

After installation, launch from the Applications folder (macOS), Start menu (Windows), or maekon command (Linux). The app starts minimized to the system tray — click the tray icon to open the main window.

2. Start independently first​

Maekon can be used independently without ONESHIM. Start in local mode first, confirm what is captured, and review the local dashboard before enabling any organization connection.

maekon --offline

3. Optional organization connection​

For teams that need on-premise deployment, admin control, terminology and relationship maps, permissions, audit logs, and governed execution, Maekon can become an optional edge input and control channel for ONESHIM. This path is separate from the Apache-2.0 desktop product and requires explicit PoC scope agreement.

If a scoped PoC has been agreed, set the endpoint provided by your organization:

# Set custom server URL (replace with your own):
maekon config set server.api_url "https://your-server.example.com"
maekon config set server.grpc_url "https://grpc.your-server.example.com"

Then sign in. Tokens are stored in the platform keychain (Keychain on macOS, Credential Manager on Windows, libsecret on Linux).

4. Grant desktop permissions​

Maekon needs platform-specific permissions to capture local work signals. The app will prompt on first run:

  • macOS — Screen Recording, Accessibility, Input Monitoring (Settings → Privacy & Security)
  • Windows — UI Automation (granted automatically on first capture)
  • Linux (X11) — runs without prompts; Wayland uses XWayland fallback

You can revoke any of these at any time — Maekon will degrade features rather than fail.

5. Confirm local candidates, automation gates, or the scoped stream​

In independent mode, the main window shows recent local activity, suggested next actions, and automation settings that require approval, policy checks, sandbox profiles, and audit logs. In a scoped ONESHIM PoC, Maekon may also open a configured stream to the organization endpoint. To stop monitoring, click the tray icon → Pause monitoring.

6. Verify the build​

$ maekon --version
maekon 0.0.1-rc.6 (build: 2026-06-13 | commit: 29f3fce82)

If the build date or commit looks unexpected, you may have an outdated install — re-run the installation command.

What's next​