Add docs for 'astro db' CLI commands to reference/cli-reference, incl…

[webstackdev]

Description (required)

Add docs for 'astro db' CLI commands to reference/cli-reference. I have a PR opened on the astro code repo to add a --db-app-token flag to the astro db execute, push, and verify commands. I'll update this PR with that number. I noticed that there was no documentation in the cli-reference document for any of the db CLI commands so I scaffolded them with relevant flags described.

Related issues & labels

For Astro version: 5.x. See astro PR 15069.

[netlify]

✅ Deploy Preview for astro-docs-2 ready!

Built without sensitive environment variables

Name	Link
🔨 Latest commit	73c2258
🔍 Latest deploy log	https://app.netlify.com/projects/astro-docs-2/deploys/694aa4150084990008aa1710
😎 Deploy Preview	https://deploy-preview-12965--astro-docs-2.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify project configuration.

[astrobot-houston]

Lunaria Status Overview

🌕 This pull request will trigger status changes.

Learn more

By default, every PR changing files present in the Lunaria configuration's files property will be considered and trigger status changes accordingly.

You can change this by adding one of the keywords present in the ignoreKeywords property in your Lunaria configuration file in the PR's title (ignoring all files) or by including a tracker directive in the merged commit's description.

Tracked Files

File	Note
en/guides/integrations-guide/db.mdx	Source changed, localizations will be marked as outdated.

Warnings reference

Icon	Description
🔄️	The source for this localization has been updated since the creation of this pull request, make sure all changes in the source have been applied.

[astrobot-houston]

Hello! Thank you for opening your first PR to Astro’s Docs! 🎉

Here’s what will happen next:

1. Our GitHub bots will run to check your changes.
   If they spot any broken links you will see some error messages on this PR.
   Don’t hesitate to ask any questions if you’re not sure what these mean!

2. In a few minutes, you’ll be able to see a preview of your changes on Netlify 🥳.

3. One or more of our maintainers will take a look and may ask you to make changes.
   We try to be responsive, but don’t worry if this takes a few days.

[webstackdev]

@withastro/maintainers-docs

[ArmandPhilippot]

Hi, thanks for creating a docs PR to accompany your core PR!

I noticed that there was no documentation in the cli-reference document for any of the db CLI commands so I scaffolded them with relevant flags described.

The CLI reference only documents commands available without any additional packages. Astro DB requires @astrojs/db and so those commands are documented on the integration reference instead: https://docs.astro.build/en/guides/integrations-guide/db/#astro-db-cli-reference

Can you revert the changes to cli-reference.mdx and move your additional docs to https://github.com/withastro/docs/blob/main/src/content/docs/en/guides/integrations-guide/db.mdx?

[webstackdev]

Can you revert the changes to cli-reference.mdx and move your additional docs to https://github.com/withastro/docs/blob/main/src/content/docs/en/guides/integrations-guide/db.mdx?

@ArmandPhilippot done. I noticed looking at those docs that the query command also accepts a --remote parameter, and so should also accept a --db-app-token CLI parameter. I updated the implementation PR on astro repo with that code change, and added it to the docs on this PR.

I also alphabetized the available flags - the ordering was inconsistent previously between the different commands (some in most-important-flag order, others in alphabetical).

[sarah11918]

(Noting that I don't see any response to the astro PR for this feature, and so normally we wait until we see some kind of indication there that this feature will be accepted, and in its current form, before looking at the docs. Things can change over the course of a feature PR, so we wait for a sign that usage/documentation is not likely to change (even if implementation does) before editing docs PRs too carefully.

I have pinged the devs to let them know we have a docs PR that is just sitting here in this state, so hopefully someone will respond to the implementation PR soon!)