Skip to content

Commit

Permalink
docs: add examples for --clear-cache and --offline
Browse files Browse the repository at this point in the history
  • Loading branch information
fiam committed Oct 11, 2022
1 parent 1bcf7f5 commit 7c12868
Showing 1 changed file with 17 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,23 @@ optional and might be turned off globally using the `--no-cache` flag.

## Clearing the Cache

`wunderctl up` will clear the cache when it starts up. To clear the cache again,
just restart it.
Cache can be emptied when `wunderctl` starts by using the `--clear-cache`
flag. Additionally, `wunderctl up` will automatically clear the cache
when it starts up. To clear the cache again, just restart it.

## Pregenerating the Cache

For CI environments that cannot perform network requests, it might be
useful to generate the cache contents and make the tests run offline.

To populate the cache contents run `wunderctl generate --clear-cache`.
This will delete any previous cache, introspect the data sources, and
finally write the cache entries. `.wunderctl/cache` can then be stored
and deployed to CI runners.

To verify that your tests can run without fetching data from the network
in a connected machine, the `--offline` flag can be used to disable loading
remote resources.

## Enable Introspection Polling

Expand Down

0 comments on commit 7c12868

Please sign in to comment.