Skip to content

feat: add cli cache clear command#590

Open
gaetansenn wants to merge 5 commits intomainfrom
cms-1438
Open

feat: add cli cache clear command#590
gaetansenn wants to merge 5 commits intomainfrom
cms-1438

Conversation

@gaetansenn
Copy link
Contributor

Following this PR

@gaetansenn gaetansenn requested a review from a team as a code owner March 16, 2026 10:19
@linear
Copy link

linear bot commented Mar 16, 2026

@vercel
Copy link

vercel bot commented Mar 16, 2026

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

Project Deployment Actions Updated (UTC)
docs Error Error Mar 17, 2026 10:07am

Request Review

Copy link
Member

@Nitwel Nitwel left a comment

Choose a reason for hiding this comment

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

Not sure if this is the right place to put these. content/configuration is mainly for documenting env vars. We should probably create a new page for cli docs if there doesn't exist one already and link to that in this file instead.

@gaetansenn
Copy link
Contributor Author

Not sure if this is the right place to put these. content/configuration is mainly for documenting env vars. We should probably create a new page for cli docs if there doesn't exist one already and link to that in this file instead.

Good point! I initially thought about creating a dedicated CLI reference page, but there isn't one yet and it would mean documenting all existing commands. I'll simplify the section here to keep it minimal, and we can track a separate PR for a proper CLI page ?

@gaetansenn
Copy link
Contributor Author

I have simplified the documentation

@Nitwel
Copy link
Member

Nitwel commented Mar 16, 2026

If possible please document the whole cli, shouldn't take that long with the help of AI and otherwise our docs will stay bad forever if we don't put in the time to fill these holes when they arise.

@gaetansenn
Copy link
Contributor Author

If possible please document the whole cli, shouldn't take that long with the help of AI and otherwise our docs will stay bad forever if we don't put in the time to fill these holes when they arise.

Alright, let’s create the entire CLI documentation here then 😅

Copy link
Member

@Nitwel Nitwel left a comment

Choose a reason for hiding this comment

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

I'd say we move the cli docs under guides/connect as that is more fitting there. Other than that, the changes look good to me. 👍

@gaetansenn
Copy link
Contributor Author

I'd say we move the cli docs under guides/connect as that is more fitting there. Other than that, the changes look good to me. 👍

Makes sense to move it out of configuration. I checked guides/connect though and it's mostly API-related stuff (auth, SDK, query params, filter rules). The CLI commands are more ops/admin (bootstrap, migrate, cache clear, start)
Did you have a specific reason for connect, or would another section like deployments be a better fit?

@Nitwel
Copy link
Member

Nitwel commented Mar 23, 2026

Our docs structure is definitely very badly chosen so that we often need to document something that doesn't belong in any of our existing categories like this. I picked guides/connect for now as that's mainly documenting how to interact with our API, but I agree we might need to open up a new category entirely for this possibly under the manage section. E.g. manage/api or somehow find a group that puts configuration and management of the api together.

@gaetansenn
Copy link
Contributor Author

Our docs structure is definitely very badly chosen so that we often need to document something that doesn't belong in any of our existing categories like this. I picked guides/connect for now as that's mainly documenting how to interact with our API, but I agree we might need to open up a new category entirely for this possibly under the manage section. E.g. manage/api or somehow find a group that puts configuration and management of the api together.

Yeah the docs structure makes this tricky. CLI commands are really about instance management (start, bootstrap, migrate, cache clear) and not really about connecting to the API.

For now, what about keeping it under configuration/ since that's where ops-related stuff already lives (migrations, cache, database)?

We can always move it later if a manage/operations or similar category gets created

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.

3 participants