Shiplogue Docs

Getting started

From a fresh install to your first synced stand-up.

1. Install the extension

Install Shiplogue from the VS Code Marketplace or Open VSX, or install the VSIX directly.

code --install-extension phenzic.shiplogue

The extension needs a trusted workspace because it reads local git history and editor activity.

2. Choose a model

You can generate locally or with your own provider key:

  • Ollama — install Ollama, then pull a model such as llama3.2.
  • BYOK — run Shiplogue: Set API Key and choose Anthropic, OpenAI, Google, or an OpenAI-compatible endpoint.

No model is bundled. Your key is stored in the editor's SecretStorage, not in settings.

3. Generate a stand-up

Open a project with today's work and run Shiplogue: Generate Today's Update or press Cmd+Shift+' / Ctrl+Shift+'. Review the draft in the panel and copy it when it is ready.

4. Connect the cloud workspace

  1. Sign in at shiplogue.dev.
  2. Open Connectors and create a key. The full key is shown once.
  3. In the editor, run Shiplogue: Connect Cloud and paste the key.
  4. Run Shiplogue: Cloud Status to verify the workspace and scopes.

Generated stand-ups are then synced as drafts. If cloud sync fails, the local draft is kept and the extension shows a warning with a Cloud status action.

What syncs

The cloud receives the finished draft, its date and title, the model label, and the estimated minutes saved setting. Raw activity, prompts, and file contents are not uploaded by the extension. Activity metadata sync is planned as a separate opt-in.