Bỏ qua để đến nội dung

Tham chiếu lệnh CLI

npm public 0.5.0 có doctor, analyze, governance check chỉ kiểm tra dependency, cùng governance run, collect và assess tám miền. Gói yêu cầu Node.js 24+. Ví dụ dùng pnpm 10.30.3 và @anhcodo13/lattice@0.5.0.

Lệnh Hành vi
--version In phiên bản CLI.
doctor [path] In phiên bản Node đang chạy và đếm file source hỗ trợ; lỗi nếu không có file nào.
init [path] Tạo .nklattice.json với phần ghi đè và policy rỗng; từ chối ghi đè file đã có.
analyze [path] Quét source, đánh giá rule, ghi báo cáo HTML và JSON.
analyze [path] --output DIR Ghi hai file báo cáo vào DIR.
governance check [path] Đối chiếu khai báo trực tiếp và lockfile với policy đi kèm.
governance check [path] --policy SOURCE Đọc policy JSON từ đường dẫn cục bộ hoặc URL HTTPS.
governance check [path] --workspace-root DIR Cho app dưới [path] dùng lockfile ở thư mục cha tới DIR.
governance check [path] --expect-apps N Yêu cầu đúng N app được quản trị; lỗi nếu số nhập sai hoặc số phát hiện khác.
governance check [path] --json In đối tượng kết quả dạng JSON.
governance run [path] --evidence FILE Chạy scanner và đánh giá trong một tiến trình; ghi bằng chứng và báo cáo. Dùng cho gate CI.
governance collect [path] --evidence FILE Chạy npm/pnpm audit, ESLint, TypeScript, Vitest, Semgrep, Gitleaks và Playwright; ghi bằng chứng chuẩn hóa ngoài gốc quét.
governance assess [path] Đánh giá inventory, policy dependency, kiến trúc, advisory, chất lượng, bảo mật source và tương thích; ghi assessment.json, report.html.
governance assess [path] --policy SOURCE --inventory FILE Chọn policy và inventory đã review; inventory phải nằm trong gốc quét.
governance assess [path] --workspace-root DIR --expect-apps N Dùng lockfile cha và kiểm thêm số app.
governance assess [path] --evidence FILE Đọc bằng chứng mới của cùng policy, đầu vào và commit. Policy nguồn đi kèm yêu cầu tùy chọn này.
governance assess [path] --output DIR --json Chọn thư mục artifact và in toàn bộ kết quả JSON.

Mọi [path] mặc định là thư mục làm việc hiện tại. Đường dẫn tương đối, gồm --output, được resolve từ thư mục của tiến trình, không tự tính từ dự án được phân tích. Nếu đứng tại checkout core và phân tích apps/web, báo cáo mặc định nằm trong apps/web/.nklattice-report.

CLI kiểm tra Node.js 24 trở lên trước mọi lệnh; phiên bản cũ hơn sẽ báo lỗi và trả mã 3. doctor cũng in phiên bản đang chạy. doctor và analyze quét .ts, .tsx, .js, .jsx, .mts, .mjs, .cts, .cjs. Chúng bỏ qua node_modules, .git, .next, dist, coverage, và *.d.ts; không đi theo symlink.

Terminal window
pnpm dlx @anhcodo13/lattice@0.5.0 doctor examples/governance/apps/vite
pnpm dlx @anhcodo13/lattice@0.5.0 analyze examples/governance/apps/vite

App Vite mẫu hiện chạy được và có test. doctor và analyze kiểm tra các file source đó; điểm thu được là chỉ báo review cục bộ, không phải chuẩn so sánh. Xem Báo cáo để biết các file được tạo.

Terminal window
pnpm dlx @anhcodo13/lattice@0.5.0 governance check examples/governance \
--workspace-root examples/governance \
--policy governance/policy.json --expect-apps 3

Bộ mẫu đạt với ba app được kiểm tra. --expect-apps nhận số nguyên dương và trả mã 3 nếu số app phát hiện khác. Số lượng không chứng minh đúng tập app; dùng governance assess để kiểm tra inventory chính xác. Khi dependency lệch, lệnh chỉ rõ app/package, ngưỡng, range, specifier, phiên bản khóa và nguyên nhân. --json có thêm phiên bản, nguồn và SHA-256 của policy mà vẫn giữ mã lỗi.

Để đánh giá đầy đủ, chạy pnpm dlx @anhcodo13/lattice@0.5.0 governance run examples/governance --policy governance/policy.json --expect-apps 3 --evidence /tmp/nklattice-governance-evidence.json. Xem trạng thái tám miền và định danh bằng chứng trong .nklattice-governance/assessment.json; HTML cùng thư mục giúp review. collect và assess vẫn có thể dùng riêng để kiểm tra cục bộ, nhưng gate CI nên dùng run để không đọc lại artifact trung gian có thể bị sửa. Hướng dẫn quản trị dự án mô tả cách cài scanner, inventory và giới hạn.

Policy mặc định được tìm tương đối với CLI đã build. Khi kiểm tra repository khác, hãy truyền --policy tường minh nếu cần một file hoặc URL đã review.

Mã Ý nghĩa Nguyên nhân thường gặp
0 Lệnh hoàn tất. assess đạt mọi miền đã cấu hình; analyze vẫn có thể trả 0 khi có finding khám phá.
7 Vi phạm policy đã đo được. Gate dependency, kiến trúc, bảo mật, chất lượng hoặc browser không đạt.
3 Chưa đủ bằng chứng hoặc lỗi lệnh. Inventory lệch, scanner lỗi, bằng chứng cũ, import nội bộ không phân giải, policy sai hoặc không đọc được file.

analyze không tự chặn theo finding; governance assess áp gate kiến trúc trung tâm trong CI.