docs: add run locally to the guide

input-output-hk · Dec 6, 2023 · 18e4edf · 18e4edf
1 parent 44d5f95
commit 18e4edf
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/docs/src/guides/spellcheck.md b/docs/src/guides/spellcheck.md
@@ -22,6 +22,18 @@ check-spelling:
     DO github.com/input-output-hk/catalyst-ci/earthly/cspell:<tag>+check-spelling
 ```
 
+### Run locally
+
+```earthfile
+spellcheck-lint:
+    # Check spelling in this repo.
+    LOCALLY
+
+    DO github.com/input-output-hk/catalyst-ci/earthly/cspell:t1.2.0+CSPELL_LOCALLY --src=$(echo ${PWD})
+```
+
+In this use case, the UDC is run Locally, so that the src in the repo can be directly checked.
+
 Executing `earthly +check-spelling` will automatically run the spell checking to all files in the repository.
 
 ## Configuration