Skip to content
New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Jump to bottom

Add CLI page #3248

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

Add CLI page #3248

steve-chavez opened this issue Jul 10, 2023 · 2 comments · May be fixed by #3481
Assignees
@taimoorzaeem
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.

@steve-chavez steve-chavez added the docs Only related to documentation label Feb 23, 2024
@taimoorzaeem taimoorzaeem self-assigned this Feb 25, 2024
@taimoorzaeem taimoorzaeem mentioned this issue Mar 9, 2024
Closed
2 tasks
@taimoorzaeem taimoorzaeem mentioned this issue Apr 27, 2024
Merged
@taimoorzaeem taimoorzaeem linked a pull request May 4, 2024 that will close this issue
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@taimoorzaeem taimoorzaeem

Labels
docs Only related to documentation
Milestone
No milestone
4 participants
@steve-chavez @wolfgangwalther @laurenceisla @taimoorzaeem