Back to Details

brief

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Project Toolchain Detection

项目工具链检测

Use 
brief
to understand a project's toolchain before doing any work. It detects languages, package managers, test runners, linters, formatters, build tools, CI, and more.
在开展任何工作前，使用
brief
来了解项目的工具链。它可以检测编程语言、包管理器、测试运行器、代码检查器、格式化工具、构建工具、CI等各类工具。

Commands

命令

Scan a project:
bash
brief .
See what changed on this branch:
bash
brief diff
Find missing recommended tooling:
bash
brief missing .
Enrich with external metadata (download counts, dependents, OpenSSF Scorecard, runtime EOL):
bash
brief enrich .
Scan a remote repo or registry package:
bash
brief https://github.com/expressjs/express
brief npm:express
brief gem:rails
brief pypi:requests
扫描项目：
bash
brief .
查看当前分支的变更内容：
bash
brief diff
查找缺失的推荐工具：
bash
brief missing .
补充外部元数据（下载量、依赖项、OpenSSF Scorecard、运行时终止支持信息）：
bash
brief enrich .
扫描远程仓库或注册表包：
bash
brief https://github.com/expressjs/express
brief npm:express
brief gem:rails
brief pypi:requests

Output

输出格式

JSON when piped, human-readable on a TTY. Force either with 
--json
or 
--human
. Filter to a single category with 
--category test
.
Use 
--verbose
to include homepage, docs, and repo links for each detected tool.
通过管道输出时为JSON格式，在TTY终端上为人类可读格式。可使用
--json
或
--human
强制指定输出格式。使用
--category test
可过滤至单个类别。
使用
--verbose
参数可包含每个检测到的工具的主页、文档及仓库链接。

When to use

使用场景

  • At the start of a conversation to understand the project
  • Before suggesting tools or configurations
  • When the user asks what tools are configured
  • When reviewing a branch to understand which parts of the toolchain are affected
  • When checking for tooling gaps before setting up CI or improving DX
  • 在开启项目沟通前了解项目情况
  • 在建议工具或配置之前
  • 当用户询问已配置哪些工具时
  • 审查分支时，了解工具链的哪些部分受到影响
  • 在搭建CI或提升开发者体验（DX）前检查工具缺口