Getting started with Objectiv

This guide takes you from zero to a first reviewed agent patch on Community edition. No license or credit card required.

1. Install the desktop app

Objectiv ships as a native app for all major desktop OSes (Tauri 2). Use the download page for platform-specific installers or build from source.

  • macOS — Open the .dmg, drag Objectiv to Applications.
  • Windows — Run the .msi or NSIS installer; WebView2 is handled by the bundle.
  • Linux — Install .deb or run the .AppImage.

Community and Enterprise use the same installer. Enterprise is unlocked later via license activation.

2. Open a workspace

  1. Launch Objectiv.
  2. Use File → Add folder to workspace (or equivalent welcome action) and choose a git repository on disk.
  3. Optional: add a second root (e.g. apps/web and apps/api) for monorepo workflows.
  4. Open the integrated terminal and confirm git status runs in the expected root.

More detail: Workspace & editor guide.

3. Configure essential settings

Open user settings (JSON) and verify agent safety defaults:

{
  "objectiv.agent.approveBeforeApply": true,
  "objectiv.marketplace.catalogUrl": "https://marketplace.project-objectiv.com/catalog.json"
}

Font, theme, and format-on-save can come from marketplace config packs—see step 5.

4. Connect a model

Objective needs an inference endpoint. Pick one:

OptionWhen to useSetup
OllamaLocal / privateInstall Ollama, pull a model, point Settings → Objective at http://127.0.0.1:11434
BYOK APICloud or corporate gatewayPaste base URL + API key in Settings; OpenAI-compatible chat completions
Dev without GPUSmoke testing UIUse any reachable compatible endpoint; agent quality depends on the model

Deep dive: Models & inference. Sidecar setup for contributors: objectiv/docs/OBJECTIVE_PILOT_OBJECTIV.md.

5. Install a marketplace pack (optional)

  1. Activity bar → Extensions (Marketplace).
  2. Search for a theme (e.g. Objectiv Ocean) → Install → leave Enabled.
  3. Packages install under ~/.objectiv/apps/<id>/ on desktop.

Browse the public list at marketplace.project-objectiv.com or read marketplace docs.

6. Run your first agent task

  1. Open the Objective panel from the activity bar.
  2. Ask for a small, verifiable change—e.g. “Add a unit test for parseVersion and run the test script.”
  3. Watch the task list: search, edit proposal, terminal output.
  4. When a patch is ready, review the diff in the approval UI. Reject once on purpose to see the loop, then accept.
  5. Run tests yourself in the terminal to confirm green.
  6. Commit from the SCM view when satisfied.

Agent behavior: Objective agent guide.

7. What to explore next

  • Use cases — monorepos, marketplace publish, Enterprise Slack
  • Integrations — chat, mail, meetings (Enterprise for send)
  • Features — full product map
  • Documentation — catalog URL, naming, build commands
  • Publish — ship a theme or snippet pack with A-Zing SSO

Appendix: build from source

cd objectiv/app && npm install && npm run dev
# Desktop dev: cd objectiv/desktop && npm run dev
# Release bundles: cd objectiv/desktop && npm run build

Web dev defaults to http://localhost:5173. Production site health and deploy: project-objectiv/scripts/deploy-vps.sh in the monorepo.