Sandboxes and CLI sandbox commands

[jmclaren]

This is a reposting of the HubSpot Developer Changelog. See there for better formatting. Also the official changelog is the source of truth if this post is ever inconsistent.
https://developers.hubspot.com/changelog/updates-to-sandboxes-and-cli-sandbox-commands

To prepare foundational work needed to deliver reliable and scalable upcoming sandbox features, we're making changes to the CLI's standard sandboxes and development sandboxes creation and sync experience in the CLI (Command Line Interface) and UI (User Interface).

What's changing?

Standard Sandboxes:

---

All HubSpot accounts with at least one enterprise Hub on their subscription can create and use Standard Sandboxes.

The Standard Sandbox creation flow in the CLI is changing.

hs sandbox create

When users run this command then choose Standard Sandbox, all supported assets will be synced from production to the standard sandbox by default.

Users can choose to trigger a one-time sync of the last updated 5K contacts and, if applicable, up to 100 associated companies, deals, and tickets (for each associated object type).

To prepare foundational work needed to deliver reliable and scalable upcoming sandbox features, the sandbox sync experience in the CLI is being sunset. New versions of the CLI do not support this command and in older versions of the CLI the command will eventually throw an error.

hs sandbox sync

Users will no longer be able to trigger a production to standard sandbox sync in the CLI. Users can continue to use the UI to sync supported assets from production to standard sandbox.

Development Sandboxes:

All HubSpot accounts enrolled in the Public beta: CRM development tools to build UI extensions with React as front end with Sales or Service Hub Enterprise. Can create and use development sandboxes.

The Development Sandbox creation experience in the CLI is changing.

hs sandbox create

When users run this CLI command, all CRM object definitions will be copied from production to development sandbox.

Users will no longer have the choice to trigger a one-time sync of the last updated 100 contacts, and if applicable, up to 10 associated companies, deals, and tickets (for each associated object type).

Users can leverage the import tool in the UI if they need to import production object record data to their development sandbox or manually create sample data for testing.

Sunset of Development Sandbox sync experience in the CLI

hs sandbox sync

Users will no longer be able to trigger a production to development sandbox sync in the CLI, and the UI version of development sandbox sync is going away.

Development sandboxes are meant to be early proof of concept, testing, and development environments. Users are encouraged to delete and create a new Development Sandbox using the CLI. This ensures development sandbox users always have an exact mirror of their production portal's CRM object definitions when they begin new projects.

Update to Development Sandbox local development in the CLI

hs project dev

When users run this command and choose to create a new development sandbox, all CRM object definitions will be copied from production to development sandbox.

Contacts will no longer be automatically copied to the development sandbox. Users can leverage the import tool in the UI if they need to import production object record data to their development sandbox or manually create sample data for testing.

When is it happening?

This change to the commands in the CLI will be included in CLI versions released after September 10th. Sometime after September 10th in older versions of the CLI the sync commands will begin returning error messages.

Questions or comments? Join us below.