Skip to content

Commit 5d6178a

Browse files
committed
add localmode docs
1 parent da50721 commit 5d6178a

File tree

2 files changed

+12
-0
lines changed

2 files changed

+12
-0
lines changed

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,5 +36,6 @@ Expect more docs soon...
3636
1. Testing checks
3737
1. [How to build X?](how-to-build-X.md)
3838
1. [Client API reference](client-api.md)
39+
1. [Localmode](localmode.md)
3940
1. [FAQ](faq.md)
4041
1. [Roadmap](roadmap.md)

localmode.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
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.

0 commit comments

Comments
 (0)