File tree 2 files changed +12
-0
lines changed
2 files changed +12
-0
lines changed Original file line number Diff line number Diff line change @@ -36,5 +36,6 @@ Expect more docs soon...
36
36
1 . Testing checks
37
37
1 . [ How to build X?] ( how-to-build-X.md )
38
38
1 . [ Client API reference] ( client-api.md )
39
+ 1 . [ Localmode] ( localmode.md )
39
40
1 . [ FAQ] ( faq.md )
40
41
1 . [ Roadmap] ( roadmap.md )
Original file line number Diff line number Diff line change
1
+ # Local mode
2
+
3
+ Local mode enables you to simulate codechecks running on your local machine.
4
+
5
+ To use it just run ` codechecks ` CLI on local machine. If you want to explicitly provide project slug
6
+ use ` --project ` option ex. ` codechecks --project krzkaczor/ts-essentials ` .
7
+
8
+ It will try to get all required information from GIT repository like project slug (based on remote
9
+ config), changed files etc. Codechecks API for public repos is read only without any auth so you can
10
+ access baselines. Any reports will be rendered in console. It will always simulate PR to master
11
+ branch.
You can’t perform that action at this time.
0 commit comments