kapi look

$ kapi look [path]

See where the project stands, or read one file with what applies to it.

With no path, look prints the project: the files kapi reads, the blocks in them, the rules in force, the findings kapi check reports, and the suggestions waiting for you in kapi rules. The first look at a project with no rules files what kapi sees in the files as suggestions. Inside a project, kapi with no command prints the same.

With a path, look prints the file's blocks in order, each one named the way kapi check and kapi inspect name it. A finding is marked with carets under the words it is about, and the rules that hold in the file follow the blocks. A file the project does not read as content is shown too, without rules.

--json gives the same as data.

Commandlook

Groupwork

Try it

Runs in your browser against a small sample file. Edit the command before running, or press Run to execute it as shown.

$ kapi look

Flags

Flag	Type	Default	Description
--project, -p	string		path to a kapi.yaml project recipe or its directory (auto-discovered from cwd if omitted)

More examples

$ kapi look docs/guide.md

$ kapi look docs/guide.md --json

← Back to the Command Reference