Skip to content

Add Environment Sync guide section - #797

Open
bryantgillespie wants to merge 7 commits into
mainfrom
bry/cli-env-sync-docs
Open

Add Environment Sync guide section#797
bryantgillespie wants to merge 7 commits into
mainfrom
bry/cli-env-sync-docs

Conversation

@bryantgillespie

Copy link
Copy Markdown
Member

New guides/environment-sync section for the env-sync CLI (d6s): overview, installation and profiles, pulling, diffing and pushing, CI, secrets and limitations, and common workflows.

Docs for an unreleased CLI; hold until it ships.

@vercel

vercel Bot commented Aug 4, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview Aug 12, 2026 3:08am

Request Review

@bryantgillespie
bryantgillespie requested a review from JamesW1 August 6, 2026 22:27
@bryantgillespie
bryantgillespie marked this pull request as ready for review August 6, 2026 22:29
@bryantgillespie
bryantgillespie requested a review from a team as a code owner August 6, 2026 22:29
- **Schema**: every collection, field, and relation, including custom fields on system collections.
- **Configuration**: roles, policies, access, permissions, flows, operations, dashboards, panels, settings, media-library folders, and custom Data Studio translation strings.
- **Opt-in**: user accounts, with every secret field stripped.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
A pull writes all of this by default, and can be narrowed. `--collections posts` limits which Schema sync files it overwrites; resource flags like `--flows` or `--no-schema` select which Configuration files it touches. That is how you promote finished work from a shared development instance while unfinished work stays out of the sync files entirely — unlike a full snapshot, a pull is not all-or-nothing. Scope is by collection and resource type, not by individual record. See [Promote only the changes that are ready](/docs/guides/environment-sync/common-workflows#promote-only-the-changes-that-are-ready).

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we need to clarify it's not all or nothing here, given the importance of that capability

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Feel free to make it less verbose than this though !

Notice what is not in it: the tokens. URLs are project configuration you commit; credentials go to `~/.directus/credentials.json`, readable only by you. Confirm both connections work:

```bash
d6s profile test-connection source

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Has the test command changed? Previously it was just d6s profile test source

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok ignore I can see it's updated 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants