์ฐธ๊ณ ํญ๋ชฉ
์ด ์ฝํ ์ธ ๋ CodeQL CLI์ ์ต์ ๋ฆด๋ฆฌ์ค์ ๋ํด ์ค๋ช ํฉ๋๋ค. ์ด ์์์ ๋ํ ์์ธํ ๋ด์ฉ์ https://github.com/github/codeql-cli-binaries/releases์(๋ฅผ) ์ฐธ์กฐํ์ธ์.
์ด์ ๋ฆด๋ฆฌ์ค์์ ์ด ๋ช
๋ น์ ์ฌ์ฉํ ์ ์๋ ์ต์
์ ์ธ๋ถ ์ ๋ณด๋ฅผ ๋ณด๋ ค๋ฉด ํฐ๋ฏธ๋์์ ์ต์
์ ์ฌ์ฉํ์ฌ --help
๋ช
๋ น์ ์คํํฉ๋๋ค.
๊ฐ์
codeql generate log-summary <options>... -- <input> <result>
codeql generate log-summary <options>... -- <input> <result>
์ค๋ช
[๊ณ ๊ธ] ๊ตฌ์กฐํ๋ ๋ก๊ทธ ํ์ผ์ ์์ฝ์ ๋ง๋ญ๋๋ค.
์ด ๋ช ๋ น์ ๊ตฌ์กฐํ๋ JSON ๊ณ์ฐ๊ธฐ ์ด๋ฒคํธ ๋ก๊ทธ์ ์์ฝ์ ๋ง๋ญ๋๋ค. ์ด ๋ช ๋ น์ ์ถ๋ ฅ์ ๋ก๊ทธ ํ์ผ ์์ฒด๋ณด๋ค ๋ค๋ฅธ ์ฌ๋ฌ ๋ฒ์ ์ CLI์์ ๋ ์์ ์ ์ผ๋ก ์ ์ง๋ฉ๋๋ค. ๋ฐ๋ผ์ ๋ก๊ทธ์ ์ถ๋ ฅ์ ์ฌ์ฉํ๋ ์คํฌ๋ฆฝํธ๋ฅผ ๊ตฌํํ๋ ๊ฒฝ์ฐ ์ด๋ฒคํธ ๋ก๊ทธ๋ฅผ ์ง์ ์ฌ์ฉํ๋ ๋์ ์ด ๋ช ๋ น์ ์คํํ๊ณ ์ถ๋ ฅ์ ์ฌ์ฉํ๋ ๊ฒ์ด ์ข์ต๋๋ค.
์ต์
๊ธฐ๋ณธ ์ต์
<input>
[ํ์] ์์ฝ์ ์์ฑํ ์ด๋ฒคํธ ๋ก๊ทธ ํ์ผ์ ๊ฒฝ๋ก์ ๋๋ค.
<result>
์์ฝ๋ ๋ก๊ทธ ํ์ผ์ ์ถ๋ ฅํ ์์น์ ๊ฒฝ๋ก์ ๋๋ค. ์๋ตํ๋ฉด ์์ฝ์ด stdout์ผ๋ก ์ถ๋ ฅ๋ฉ๋๋ค.
--minify-output
ํด๋นํ๋ ๊ฒฝ์ฐ ์ถ๋ ฅ๋ ์์ฝ์์ ๊ณต๋ฐฑ์ ์๋ตํฉ๋๋ค. ๊ทธ ๊ฒฐ๊ณผ ์ฌ์ฉ์๊ฐ ์ฝ์ ์๋ ์ ์ง๋ง ๋ฉ๋ชจ๋ฆฌ๋ ์ค์ด๋ญ๋๋ค. ์ด ์ต์ ์ ์ผ๋ถ ์ถ๋ ฅ ํ์์๋ง ์ ์ฉ๋ฉ๋๋ค.
--utc
[๊ณ ๊ธ] ์ด ๋ช ๋ น์์ ์์ฑ๋ ์์ฝ์ ํน์ ํ์์คํฌํ๋ ์คํ ์ค์ธ ์ปดํจํฐ์ ํ์ง ํ์ค ์๊ฐ๋๋ฅผ ์ฌ์ฉํ ์ ์์ต๋๋ค. ์ด ํ๋๊ทธ๋ฅผ ์ฌ์ฉํ๋๋ก ์ค์ ํ๋ฉด ๋ชจ๋ ํ์์คํฌํ๊ฐ UTC๊ฐ ๋ฉ๋๋ค.
--format=<format>
์์ฑ๋ ์ถ๋ ฅ์ ํ์์ ์ ์ดํฉ๋๋ค.
predicates
(๊ธฐ๋ณธ๊ฐ): ๊ฐ ์กฐ๊ฑด์์์ ์ํ๋๋ ๊ณ์ฐ์ ์์ฝ์ ์์ฑํฉ๋๋ค. ์ด ์คํธ๋ฆผ์ ๋ ๊ฐ์ ์ค ๋ฐ๊ฟ ๋ฌธ์(๊ธฐ๋ณธ)๋ก ๊ตฌ๋ถ๋ JSON ๊ฐ์ฒด์ ์คํธ๋ฆผ์ด๊ฑฐ๋ --minify-output
์ต์
์ด ์ ๋ฌ๋ ๊ฒฝ์ฐ ํ ๊ฐ์
๋๋ค.
text
: ์ฌ์ฉ์๊ฐ ์ฝ์ ์ ์๋ ํ๊ฐ ์คํ ์์ฝ์ ์์ฑํฉ๋๋ค.
overall
: ๋ช ๊ฐ์ง ์์ฝ ํต๊ณ์ ๊ฐ์ฅ ์๊ฐ์ด ๋ง์ด ์์๋๋ ํ๊ฐ์ ๋ํ ์ ๋ณด๋ฅผ ํฌํจํ์ฌ ํ๊ฐ ์คํ์ ๋ํ ์ ๋ฐ์ ์ธ ์ ๋ณด์ ์ผ๋ถ๊ฐ ํฌํจ๋ JSON ํ์ผ์ ์์ฑํฉ๋๋ค.
--[no-]deduplicate-stage-summaries
[๊ณ ๊ธ] ์ด ์ต์ ์ ํ ์คํธ ํ์๊ณผ ํจ๊ป๋ง ์๋ํฉ๋๋ค. ์ด ๊ฐ์ด ์ ๋ฌ๋๋ฉด ์ฟผ๋ฆฌ ๊ฐ์ ๊ณต์ ๋๋ ๋จ๊ณ์ ๋ํด ๊ฐ์ฅ ๋น์ผ ์กฐ๊ฑด์๊ฐ ํฌํจ๋ ์์ฝ ํ ์ด๋ธ์ด ๋ฐ๋ณต๋์ง ์์ต๋๋ค. ์ด๋ ๊ฒ ํ๋ฉด ์ฟผ๋ฆฌ๊ฐ ์๋ฃ๋ ์์ ์ ๊ฐ ์ฟผ๋ฆฌ์ ๋ํ ํ ์ด๋ธ์ด ํ์๋์ง ์๊ณ ๋ชจ๋ ์์ฝ ํ ์ด๋ธ์ด ๋ก๊ทธ์ ๋์ผ๋ก ์ด๋ํ๋ ๋ถ์์ฉ์ด ๋ฐ์ํฉ๋๋ค.
์ผ๋ฐ ์ต์
-h, --help
์ด ๋์๋ง ํ ์คํธ๋ฅผ ํ์ํฉ๋๋ค.
-J=<opt>
[๊ณ ๊ธ] ๋ช ๋ น์ ์คํํ๋ JVM์ ์ต์ ์ ์ง์ ํฉ๋๋ค.
(๊ณต๋ฐฑ์ ํฌํจํ๋ ์ต์ ์ ์ฌ๋ฐ๋ฅด๊ฒ ์ฒ๋ฆฌ๋์ง ์์ ์ ์์ผ๋ ์ฃผ์ํ์ธ์.)
-v, --verbose
์ถ๋ ฅ๋๋ ์งํ๋ฅ ๋ฉ์์ง ์๋ฅผ ์ ์ง์ ์ผ๋ก ๋๋ฆฝ๋๋ค.
-q, --quiet
์ถ๋ ฅ๋๋ ์งํ๋ฅ ๋ฉ์์ง ์๋ฅผ ์ ์ง์ ์ผ๋ก ์ค์ ๋๋ค.
--verbosity=<level>
[๊ณ ๊ธ] ์ธ๋ถ ์ ๋ณด ํ์ ์์ค์ ์ค๋ฅ, ๊ฒฝ๊ณ , ์งํ๋ฅ , ์งํ๋ฅ +, ์งํ๋ฅ ++, ์งํ๋ฅ +++ ์ค ํ๋๋ก ๋ช
์์ ์ผ๋ก ์ค์ ํฉ๋๋ค. -v
๋ฐ -q
๋ฅผ ์ฌ์ ์ํฉ๋๋ค.
--logdir=<dir>
[๊ณ ๊ธ] ํ์์คํฌํ์ ์คํ ์ค์ธ ํ์ ๋ช ๋ น์ ์ด๋ฆ์ ํฌํจํ๋ ์์ฑ๋ ์ด๋ฆ์ ์ฌ์ฉํ์ฌ ์ง์ ๋ ๋๋ ํฐ๋ฆฌ์ ์๋ ํ๋ ์ด์์ ํ์ผ์ ์์ธํ ๋ก๊ทธ๋ฅผ ๊ธฐ๋กํฉ๋๋ค.
(๋ชจ๋ ๊ถํ์ ๊ฐ์ง ์ด๋ฆ์ผ๋ก ๋ก๊ทธ ํ์ผ์ ์์ฑํ๋ ค๋ฉด --log-to-stderr
์(๋ฅผ) ์ง์ ํ๊ณ stderr๋ฅผ ์ํ๋ ๋๋ก ๋ฆฌ๋๋ ์
ํฉ๋๋ค.)
--common-caches=<dir>
[๊ณ ๊ธ] ๋ค์ด๋ก๋ํ QL ํฉ ๋ฐ ์ปดํ์ผ๋ ์ฟผ๋ฆฌ ๊ณํ๊ณผ ๊ฐ์ด ์ฌ๋ฌ CLI ์คํ ๊ฐ์ ์ ์ง๋๋ ๋์คํฌ์ ์บ์๋ ๋ฐ์ดํฐ์ ์์น๋ฅผ ์ ์ดํฉ๋๋ค. ๋ช
์์ ์ผ๋ก ์ค์ ํ์ง ์์ ๊ฒฝ์ฐ ์ด ๊ธฐ๋ณธ๊ฐ์ ์ฌ์ฉ์์ ํ ๋๋ ํฐ๋ฆฌ์ ์ด๋ฆ์ด ์ง์ ๋ .codeql
๋๋ ํฐ๋ฆฌ๋ก ์ค์ ๋๋ฉฐ, ์์ง ์๋ ๊ฒฝ์ฐ ๋ง๋ค์ด์ง๋๋ค.
v2.15.2
๋ถํฐ ์ฌ์ฉํ ์ ์์ต๋๋ค.