Skip to content

Commit 57d11c7

Browse files
chore: Update nix/README's command list
We had added the release tools by default a while ago.. and by now have many more tools available.
1 parent fdc26d5 commit 57d11c7

File tree

2 files changed

+29
-21
lines changed

2 files changed

+29
-21
lines changed

nix/README.md

Lines changed: 28 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -72,39 +72,47 @@ The PostgREST utilities available in `nix-shell` all have names that begin with
7272
```bash
7373
# Note: The utilities listed here might not be up to date.
7474
[nix-shell]$ postgrest-<tab>
75-
postgrest-build postgrest-test-spec
76-
postgrest-check postgrest-watch
77-
postgrest-clean postgrest-with-all
78-
postgrest-coverage postgrest-with-postgresql-12
79-
postgrest-lint postgrest-with-postgresql-13
80-
postgrest-run postgrest-with-postgresql-14
81-
postgrest-style postgrest-with-postgresql-15
82-
postgrest-style-check postgrest-with-postgresql-16
83-
postgrest-test-io postgrest-with-postgresql-17
75+
postgrest-build postgrest-parallel-curl
76+
postgrest-check postgrest-profiled-run
77+
postgrest-clean postgrest-push-cachix
78+
postgrest-coverage postgrest-release
79+
postgrest-coverage-draft-overlay postgrest-repl
80+
postgrest-docs-build postgrest-run
81+
postgrest-docs-check postgrest-style
82+
postgrest-docs-dictcheck postgrest-style-check
83+
postgrest-docs-linkcheck postgrest-test-big-schema
84+
postgrest-docs-render postgrest-test-doctests
85+
postgrest-docs-serve postgrest-test-io
86+
postgrest-docs-spellcheck postgrest-test-replica
87+
postgrest-dump-minimal-imports postgrest-test-spec
88+
postgrest-dump-schema postgrest-test-spec-idempotence
89+
postgrest-gen-ctags postgrest-watch
90+
postgrest-gen-jwt postgrest-with-all
91+
postgrest-gen-secret postgrest-with-git
92+
postgrest-git-hooks postgrest-with-pgrst
93+
postgrest-hsie-graph-modules postgrest-with-postgresql-12
94+
postgrest-hsie-graph-symbols postgrest-with-postgresql-13
95+
postgrest-hsie-minimal-imports postgrest-with-postgresql-14
96+
postgrest-lint postgrest-with-postgresql-15
97+
postgrest-loadtest postgrest-with-postgresql-16
98+
postgrest-loadtest-against postgrest-with-postgresql-17
99+
postgrest-loadtest-report postgrest-with-slow-pg
100+
postgrest-nixpkgs-upgrade postgrest-with-slow-postgrest
84101
...
85102

86103
[nix-shell]$
87104

88105
```
89106

90-
Some additional modules like `memory`, `docker` and `release`
107+
Some additional modules like `memory` and `docker`
91108
have large dependencies that would need to be built before the shell becomes
92109
available, which could take an especially long time if the cachix binary cache
93110
is not used. You can activate those by passing a flag to `nix-shell` with
94111
`nix-shell --arg <module> true`. This will make the respective utilities available:
95112

96113
```bash
97114
$ nix-shell --arg memory true
98-
[nix-shell]$ postgrest-<tab>
99-
postgrest-build postgrest-test-spec
100-
postgrest-check postgrest-watch
101-
postgrest-clean postgrest-with-all
102-
postgrest-coverage postgrest-with-postgresql-12
103-
postgrest-lint postgrest-with-postgresql-13
104-
postgrest-run postgrest-with-postgresql-14
105-
postgrest-style postgrest-with-postgresql-15
106-
postgrest-style-check postgrest-with-postgresql-16
107-
postgrest-test-io postgrest-with-postgresql-17
115+
[nix-shell]$ postgrest-test-m<tab>
108116
postgrest-test-memory
109117
...
110118

shell.nix

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,10 @@ let
2424
postgrest.docs
2525
postgrest.loadtest
2626
postgrest.nixpkgsTools
27+
postgrest.release
2728
postgrest.style
2829
postgrest.tests
2930
postgrest.withTools
30-
postgrest.release
3131
]
3232
++ lib.optional docker postgrest.docker
3333
++ lib.optional memory postgrest.memory;

0 commit comments

Comments
 (0)