์ฐธ๊ณ ํญ๋ชฉ
์ด ์ฝํ ์ธ ๋ CodeQL CLI์ ์ต์ ๋ฆด๋ฆฌ์ค์ ๋ํด ์ค๋ช ํฉ๋๋ค. ์ด ์์์ ๋ํ ์์ธํ ๋ด์ฉ์ https://github.com/github/codeql-cli-binaries/releases์(๋ฅผ) ์ฐธ์กฐํ์ธ์.
์ด์ ๋ฆด๋ฆฌ์ค์์ ์ด ๋ช
๋ น์ ์ฌ์ฉํ ์ ์๋ ์ต์
์ ์ธ๋ถ ์ ๋ณด๋ฅผ ๋ณด๋ ค๋ฉด ํฐ๋ฏธ๋์์ ์ต์
์ ์ฌ์ฉํ์ฌ --help
๋ช
๋ น์ ์คํํฉ๋๋ค.
๊ฐ์
codeql resolve files <options>... -- <dir>
codeql resolve files <options>... -- <dir>
์ค๋ช
[์ฌ์ธต ์ฐ๊ฒฐ] ํ์ผ ํฌํจ/์ ์ธ GLOB ์งํฉ์ ํ์ฅํฉ๋๋ค.
์ด ์ฐ๊ฒฐ ๋ช ๋ น์ ๊ฒฝ๋ก๋ก ์๋ณ๋๋ ์ฌ๋ฌ ํ์ผ์์ ์๋ํ๋ ํ์ ๋ช ๋ น์ ๋ช ๋ น์ค ๋งค๊ฐ ๋ณ์๋ฅผ ํ์ฅํ๋ ์ญํ ์ ํฉ๋๋ค. ๊ธฐ๋ณธ์ ์ผ๋ก ๋ชจ๋ ํ์ผ์ด ํฌํจ๋๋ฏ๋ก ํํฐ ์ธ์ ์์ด ์ด ๋ช ๋ น์ ์คํํ๋ฉด ๋๋ ํฐ๋ฆฌ์ ๋ชจ๋ ํ์ผ์ ์์งํฉ๋๋ค.
--include
, --exclude
๋ฐ --prune
์ต์
์ ๋ชจ๋ ๋ค์๊ณผ ๊ฐ์ ์์ผ๋์นด๋ ๋ฌธ์๋ฅผ ์ฌ์ฉํ ์ ์๋ GLOB ํจํด์ ์ฌ์ฉํฉ๋๋ค.
- ๋จ์ผ "?"๋ ์ฌ๋์/๋ฐฑ์ฌ๋์๋ฅผ ์ ์ธํ ๋ชจ๋ ๋ฌธ์์ ์ผ์นํฉ๋๋ค.
- ๋จ์ผ "*"๋ ์ฌ๋์/๋ฐฑ์ฌ๋์๋ฅผ ์ ์ธํ ๋ชจ๋ ๋ฌธ์ ์์ ์ผ์นํฉ๋๋ค.
- ํจํด "**"๋ 0๊ฐ ์ด์์ ์ ์ฒด ๋๋ ํฐ๋ฆฌ ๊ตฌ์ฑ ์์์ ์ผ์นํฉ๋๋ค.
์ต์
๊ธฐ๋ณธ ์ต์
<dir>
๊ฒ์ํ ๋๋ ํฐ๋ฆฌ์ ๋๋ค.
--format=<fmt>
์ถ๋ ฅ ํ์(text
(๊ธฐ๋ณธ๊ฐ) ๋๋ json
)์ ์ ํํฉ๋๋ค.
์์งํ ํ์ผ ์งํฉ์ ์ ํํ๋ ์ต์
--include-extension=<.ext>
์ง์ ๋ ํ์ฅ๋ช
์ ๊ฐ๋ ๊ฒ์ ๋๋ ํฐ๋ฆฌ ํธ๋ฆฌ์ ๋ชจ๋ ํ์ผ์ ํฌํจํฉ๋๋ค. ์ผ๋ฐ์ ์ผ๋ก ํ์ฅ๋ช
์์ ์ ์ ํฌํจํด์ผ ํฉ๋๋ค.
์๋ฅผ ๋ค์ด --include-extension .xml
์ ๋ฌ์๋ ".xml" ํ์ฅ๋ช
์ ๊ฐ๋ ๋ชจ๋ ํ์ผ์ด ํฌํจ๋ฉ๋๋ค. ์ด ์ต์
์ ๋ถ์ ๋ --include
์ต์
๊ณผ ํธํ๋์ง ์์ต๋๋ค.
--include=<glob>
๊ฒ์ ๋๋ ํฐ๋ฆฌ์์ ๊ฐ ํ์ผ ๋ฐ ๋๋ ํฐ๋ฆฌ์ ์๋ ๊ฒฝ๋ก๋ฅผ ์ฌ์ฉํ์ฌ ์ง์ ๋ GLOB์ ์ผ์นํ๋ ๊ฒ์ ๋๋ ํฐ๋ฆฌ ํธ๋ฆฌ์ ๋ชจ๋ ํ์ผ ๋ฐ ๋๋ ํฐ๋ฆฌ๋ฅผ ํฌํจํฉ๋๋ค. GLOB๊ฐ !
๋ฌธ์๋ก ์์ํ๋ ๊ฒฝ์ฐ ์ผ์นํ๋ ํ์ผ ๋ฐ ๋๋ ํฐ๋ฆฌ๋ ์ ์ธ๋ฉ๋๋ค.
--include
์ต์
์ ์์๋๋ก ์ฒ๋ฆฌ๋๋ฉฐ ์ดํ ์ต์
์ด ์ด์ ์ต์
์ ์ฌ์ ์ํฉ๋๋ค. ์๋ฅผ ๋ค์ด --include ** --include !sub/*.ts --include sub/main.*
๋ sub/main.ts
๋ฅผ ํฌํจํ๊ณ (sub/main.*
์ ์ํด ํฌํจ๋๊ธฐ ๋๋ฌธ), sub/index.ts
๋ฅผ ์ ์ธํ๋ฉฐ(!sub/*.ts
์ ์ํด ์ ์ธ๋๊ธฐ ๋๋ฌธ) sub/test.js
๋ฅผ ํฌํจํฉ๋๋ค(์ดํ์ ์ ์ธ๋์ง ์๊ณ **
์ ์ํด ํฌํจ๋๊ธฐ ๋๋ฌธ).
--also-match=<glob>
๊ฒ์ ๋๋ ํฐ๋ฆฌ์์ ๊ฐ ํ์ผ ๋ฐ ๋๋ ํฐ๋ฆฌ์ ์๋ ๊ฒฝ๋ก๋ฅผ ์ฌ์ฉํ์ฌ ๋ชจ๋ ๊ฒฐ๊ณผ๊ฐ ์ง์ ๋ GLOB์ ์ผ์นํ๋๋ก ์๊ตฌํฉ๋๋ค. ์ด ์ต์
์ --include
์ ๊ตฌ์กฐ ๋ฐ ํด์์ด ๋์ผํ์ง๋ง --include
์ ํจ๊ป ์ ์ฉ๋๋ ๋ณ๋์ GLOB ์ํ์ค๋ฅผ ์ง์ ํฉ๋๋ค.
--exclude=<glob>
๊ฒ์ ๋๋ ํฐ๋ฆฌ์์ ๊ฐ ํ์ผ ๋ฐ ๋๋ ํฐ๋ฆฌ์ ์๋ ๊ฒฝ๋ก๋ฅผ ์ฌ์ฉํ์ฌ ์ง์ ๋ GLOB์ ์ผ์นํ๋ ๋ชจ๋ ํ์ผ ๋ฐ ๋๋ ํฐ๋ฆฌ๋ฅผ ์ ์ธํฉ๋๋ค. ์ด ์ต์
์ ๋ชจ๋ include ์ต์
์ ์ฌ์ ์ํฉ๋๋ค. ์ด ์ต์
์ ๋ถ์ ๋ --include
์ต์
๊ณผ ํธํ๋์ง ์์ต๋๋ค.
--prune=<glob>
๊ฒ์ ๋๋ ํฐ๋ฆฌ์์ ๊ฐ ํ์ผ ๋ฐ ๋๋ ํฐ๋ฆฌ์ ์๋ ๊ฒฝ๋ก๋ฅผ ์ฌ์ฉํ์ฌ ์ง์ ๋ GLOB์ ์ผ์นํ๋ ๋ชจ๋ ํ์ผ ๋ฐ ๋๋ ํฐ๋ฆฌ๋ฅผ ์ ์ธํฉ๋๋ค. ์ด ์ต์
์ ๋ชจ๋ include ์ต์
์ ์ฌ์ ์ํฉ๋๋ค. ์ด ์ต์
์ ๋ถ์ ๋ --include
์ต์
๊ณผ ํธํ๋์ง ์์ต๋๋ค.
--size-limit=<bytes>
ํฌ๊ธฐ๊ฐ ์ง์ ๋ ์ ํ์ ์ด๊ณผํ๋ ๋ชจ๋ ํ์ผ์ ์ ์ธํฉ๋๋ค. ํฌ๊ธฐ ์ ํ์ ๋ฐ์ดํธ ๋จ์ ๋๋ "k" ์ ๋ฏธ์ฌ๋ฅผ ์ฌ์ฉํ๋ KiB(ํค๋น๋ฐ์ดํธ), "m" ์ ๋ฏธ์ฌ๋ฅผ ์ฌ์ฉํ๋ MiB(๋ฉ๋น๋ฐ์ดํธ), "g" ์ ๋ฏธ์ฌ๋ฅผ ์ฌ์ฉํ๋ GiB(๊ธฐ๋น๋ฐ์ดํธ) ๋จ์์ ๋๋ค. ์ด ์ต์ ์ ๋ชจ๋ include ์ต์ ์ ์ฌ์ ์ํฉ๋๋ค.
--total-size-limit=<bytes>
ํ์ธ๋ ๋ชจ๋ ํ์ผ์ ๊ฒฐํฉ๋ ํฌ๊ธฐ๊ฐ ์ง์ ๋ ์ ํ์ ์ด๊ณผํ๋ ๊ฒฝ์ฐ ๋ช ๋ น์ด ์ค๋ฅ์ ํจ๊ป ์ข ๋ฃ๋๋๋ก ํฉ๋๋ค. ํฌ๊ธฐ ์ ํ์ ๋ฐ์ดํธ ๋จ์ ๋๋ "k" ์ ๋ฏธ์ฌ๋ฅผ ์ฌ์ฉํ๋ KiB(ํค๋น๋ฐ์ดํธ), "m" ์ ๋ฏธ์ฌ๋ฅผ ์ฌ์ฉํ๋ MiB(๋ฉ๋น๋ฐ์ดํธ), "g" ์ ๋ฏธ์ฌ๋ฅผ ์ฌ์ฉํ๋ GiB(๊ธฐ๋น๋ฐ์ดํธ) ๋จ์์ ๋๋ค.
--[no-]follow-symlinks
๋์์ ๋ํ ๋ฐ๋ก ๊ฐ๊ธฐ ๋งํฌ๋ฅผ ๋ฐ๋ฆ ๋๋ค.
--[no-]find-any
์ต๋ ํ๋์ ์ผ์น ํญ๋ชฉ์ ์ฐพ์ต๋๋ค(๋ชจ๋ ์ผ์น ํญ๋ชฉ์ด ์๋).
v2.11.3
๋ถํฐ ์ฌ์ฉํ ์ ์์ต๋๋ค.
์ผ๋ฐ ์ต์
-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
๋ถํฐ ์ฌ์ฉํ ์ ์์ต๋๋ค.