Skip to main content
2026-06-24
Client 1.0

Migrating to 1.0

This guide helps you migrate from Snowglobe client 0.9.x to 1.0.x. The breaking changes are all in the CLI: the binary and two commands were renamed, and connect (formerly start) now requires --simulation-id.

Installation

1.0.1a1 is a pre-release, so allow pre-releases when upgrading:
pip install --pre --upgrade snowglobe
# or, if you use uv:
uv pip install --prerelease=allow --upgrade snowglobe
The console command was previously published under the snowglobe-connect name. If you installed an older distribution under a different name, uninstall it first (pip uninstall snowglobe-connect snowglobe-mirror) so the snowglobe command resolves to the new version. Verify with snowglobe --version.

Backwards-incompatible changes

  1. The CLI command is now snowglobe (was snowglobe-connect).
  2. snowglobe-connect authsnowglobe login.
  3. snowglobe-connect startsnowglobe connect, and --simulation-id is now required. Each connect process is dedicated to exactly one simulation.

Command rename reference

0.9.x1.0.x
snowglobe-connect authsnowglobe login
snowglobe-connect initsnowglobe init
snowglobe-connect testsnowglobe test
snowglobe-connect startsnowglobe connect --simulation-id <id>
snowglobe-connect start --agent-ids <ids>snowglobe connect --simulation-id <id> --agent-ids <ids>
snowglobe-connect simulate ./config.ymlsnowglobe simulate ./config.yml
snowglobe-connect replay ./config.ymlsnowglobe replay ./config.yml
snowglobe-connect select-organizationsnowglobe select-organization
snowglobe-connect list-agent-profilessnowglobe list-agent-profiles

connect requires --simulation-id

In 0.9.x, start could run without a simulation ID and act as a long-running poller that picked up any eligible simulation. In 1.0.x, connect is scoped to a single simulation and --simulation-id is required — a bare snowglobe connect errors out.
# version 0.9.x — headless poller for all eligible simulations
snowglobe-connect start

# version 1.0.x — dedicated to one simulation
snowglobe connect --simulation-id <simulation-id>
If you previously ran one process to service many simulations, run one connect process per simulation instead. To create a simulation and connect to it in a single step, use snowglobe simulate or snowglobe replay, which create the simulation and then connect for you.Get a simulation ID from the Snowglobe dashboard (on the simulation’s page or in its URL). See the connect reference for details.

Non-breaking improvements

These are additive — no action required, but worth knowing.

init logs you in and can create agents

snowglobe init no longer requires you to authenticate first: if you’re not logged in, it runs the login flow inline and continues. It can also create a brand-new agent for you — choose the New Agent option in the selection prompt and enter a name and description.

Migrate with an AI agent

If you drive your migrations with Claude Code, Codex, or another coding agent, paste the prompt below. It is self-contained and describes the exact, mechanical edits. Run it from the root of the repository you want to migrate.
You are migrating a repository's usage of the Snowglobe CLI client from version
0.9.x to 1.0.x. The changes are entirely in how the `snowglobe-connect` CLI is
installed and invoked. Make the edits below, then report a summary of every file
you changed.

## Scope

Search the ENTIRE repo for references to the old CLI, including:
- shell scripts (*.sh), Makefiles, justfiles, Taskfiles
- CI/CD configs (.github/workflows/*.yml, .gitlab-ci.yml, CircleCI, Jenkinsfile,
  Azure Pipelines, etc.)
- Dockerfiles and docker-compose files
- package.json scripts, npm/yarn/pnpm scripts, tox.ini, noxfile
- README / docs / *.md / *.mdx
- any wrapper scripts, .env files, or process managers (systemd units,
  supervisor, pm2, Procfile)

Do NOT change unrelated text. Do NOT touch references that are intentionally
pinned to "snowglobe<=0.4.x" / "0.4.x" legacy docs.

## Rename rules (apply in this order, longest match first)

1. `snowglobe-connect auth`  ->  `snowglobe login`
2. `snowglobe-connect start` ->  `snowglobe connect`   (then apply rule 4 below)
3. Any remaining `snowglobe-connect <subcommand>` (init, test, simulate, replay,
   select-organization, list-agent-profiles, init-metric, test-metric,
   connect-metric, --version, --help, etc.)  ->  `snowglobe <subcommand>`
4. A bare `snowglobe-connect` used as the command/binary name (including in
   prose and install instructions like `pip install snowglobe-connect`)
   ->  `snowglobe`

## Required behavioral change: `--simulation-id`

In 1.0.x, `snowglobe connect` (formerly `start`) REQUIRES `--simulation-id`.
A bare `snowglobe connect` now errors.

- If an old invocation already passed `--simulation-id <X>`, keep it.
- If an old `start` invocation had NO simulation id (it relied on the headless
  "process all simulations" behavior, which no longer exists), you cannot
  invent an ID. In that case:
  - For automated/CI usage, prefer rewriting it to create-and-connect in one
    step: `snowglobe simulate ./config.yml` (or `snowglobe replay ./config.yml`
    for trace-regression). Only do this if a simulate/replay config file exists
    or the surrounding context makes the intent clear.
  - Otherwise, replace it with `snowglobe connect --simulation-id <SIMULATION_ID>`
    and leave `<SIMULATION_ID>` as an explicit placeholder. Add a brief comment
    next to it (in whatever comment syntax the file uses) explaining that the
    user must supply the target simulation's ID, because 1.0.x dedicates each
    connect process to a single simulation.
  - Flag every such spot in your final summary so a human can fill in the ID.

## Installation references

- The pip package name is still `snowglobe` (unchanged).
- `1.0.1a1` is a pre-release. Where you see an install command, ensure pre-
  releases are allowed: `pip install --pre snowglobe` (or
  `uv pip install --prerelease=allow snowglobe`).
- If the repo installs an old distribution name (`snowglobe-connect` or
  `snowglobe-mirror`), change it to install `snowglobe` and note that the old
  one should be uninstalled.

## Verify

- After editing, grep the repo to confirm no `snowglobe-connect` invocations
  remain except intentionally-pinned legacy 0.4.x references.
- Confirm every `snowglobe connect` invocation either has `--simulation-id`
  or was deliberately left with a flagged `<SIMULATION_ID>` placeholder.
- Do not run the CLI or network calls; this is a source-edit-only task.

## Report

List each changed file with a one-line description, and a separate list of any
`<SIMULATION_ID>` placeholders that a human still needs to fill in.
After the agent finishes, fill in any <SIMULATION_ID> placeholders it flagged, then run snowglobe --version to confirm the new CLI resolves, and snowglobe test to confirm your wrapper still works.
2025-09-08
v0.1.5
🚀 Major Features
  • Payment Integration - Complete payment processing system with billing address forms and card management
  • AI Model Updates - Added latest GPT-4o and Claude Opus models
🔧 Improvements
  • Enhanced Organization Management - Improved organization capabilities and settings
  • MLflow Export - Export simulation data to ML Flow. Oauth coming soon!
🐛 Bug Fixes
  • Organization Invites - Fixed role selection issues
  • Hallucination Detection - Now properly disabled when no documents are available
  • Limited Subject Area - Removed minimum relevance limits for easier use
2025-09-01
v0.1.4
🎨 UI/UX Enhancements
  • Smart Chart Legends - Legends now automatically hide on tables and show on spatial maps for better readability
  • Terminology Updates - Continued improvements to report naming and clarity
2025-08-25
v0.1.3
🎨 Major UI Improvements
  • Rich Text Editor - Replaced markdown editor with a different markdown library
  • Enhanced Spatial Visualizations - Added comprehensive legends, improved heatmap sizing, and better progress visualization
💳 Payment System
  • Stripe Integration - Added payment processing with billing address forms and Link payment support
  • Free Credit System - New system for users without payment methods
📊 Data & Visualization
  • Improved Topic Clustering - Better loading states and refresh capabilities
  • Chart Fixes - Resolved scatter plot and distribution chart rendering issues
  • Enhanced Reports - Added personas and improved report functionality
🐛 Bug Fixes & Polish
  • Sharing Functionality - Fixed content sharing issues
  • Breadcrumb Navigation - Changed chevrons to dots for cleaner navigation
  • UI Responsiveness - Fixed blocking interactions and improved overall responsiveness
2025-08-22
v0.1.2
  • Preview links are back! On your simulation, click the ”…” button and “Share”. This creates a public link to your simulation that remains valid for 3 days.
  • Added a legend to the simulation spatial view.
  • Simulations performance boost. Heat maps and tree maps now load in under a second, after initial computation.
2025-08-14
v0.1.1
Snowglobe GA launch!
2025-08-04
v0.1.0
Public preview of Snowglobe!!