Skip to content

Commit

Permalink
📝 Add explanation for CLI check command
Browse files Browse the repository at this point in the history
  • Loading branch information
ionesosa-e authored and giacomocavalieri committed Feb 4, 2025
1 parent b276af3 commit 3988007
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -147,6 +147,16 @@ work:
> defining two functions `find_squirrel` and `list_squirrels` you can then
> import and use in your code.
### CLI Commands
Squirrel offers the following commands to streamline your workflow:
- `gleam run -m squirrel`: Generates type-safe Gleam code for all SQL queries
found in `src/**/sql/*.sql`.
- `gleam run -m squirrel check`: Validates that the generated Gleam code is
up-to-date with the SQL queries. This is particularly useful to run in a CI
pipeline to make sure you don't forget to run `gleam run -m squirrel`.
### Talking to the database
In order to understand the type of your queries, Squirrel needs to connect to
Expand Down

0 comments on commit 3988007

Please sign in to comment.