Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Add CLI page #3248

Closed
steve-chavez opened this issue Jul 10, 2023 · 2 comments · May be fixed by #3481
Closed

Add CLI page #3248

steve-chavez opened this issue Jul 10, 2023 · 2 comments · May be fixed by #3481
Assignees
Labels
docs Only related to documentation

Comments

@steve-chavez
Copy link
Member

The CLI is undocumented right now.

We need this page to document #2856.

There's some extra work here:

  • --dump-schema should be called --dump-schema-cache. Or perhaps --dump-scache as an alias.
  • --example only shows a config file example. It should show env vars and maybe in-db config.
  • A mention about using --dump-schema with jq.
@laurenceisla
Copy link
Member

An idea for --example: maybe adding parameters could get different configs, e.g. --example CONFIGTYPE, where CONFIGTYPE may be one of 'file', 'env', 'db' or something like that.

@wolfgangwalther wolfgangwalther transferred this issue from PostgREST/postgrest-docs Feb 20, 2024
@wolfgangwalther
Copy link
Member

I transferred this issue back from the postgrest-docs repo. It didn't really fit into any of the other "collection" issues - it is in fact the only issue that is a clear cut "missing" in the references section. That deserves a separate issue, I guess.

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
docs Only related to documentation
4 participants