GitHub 副驾驶 CLI
让GitHub Copilot在命令行上帮助你的CLI体验.
注意: GitHub 副驾驶 CLI 在 技术预览。 。 。 . 期待粗糙的角落和 支持不足的平台. 要进入GitHub副驾驶CLI, 在等待列表上签名。 。 。 .
GitHub Copilot CLI 将自然语言翻译为 shell 命令,有不同域的模式. 安装后,可以使用以下三个命令: 1
??: 将自然语言翻译为任意的 shell 命令git?: 将自然语言翻译为 Git 命令gh?: 将自然语言翻译为 GitHub CLI 命令
GitHub Copilot CLI也会尝试分解,逐个解释建议命令会做什么.
要使用 GitHub 副驾驶 CLI, 你必须能够访问 GitHub 副驾驶。 。 。 .
支持的平台
GitHub Copilot CLI 基本上应该广泛跨平台,终端和贝壳工作,但对Linux上的zsh有偏向.
因此,它可能建议您命令在您的平台或终端上不起作用.
如果发生这种情况,考虑使用 revise 选项可以告诉 GitHub 副驾驶 CLI 您在哪个平台上.
化名命令只测试在zsh和bash上工作.
我们赞赏所有关于 GitHub 副驾驶CLI 在你的平台上工作, 以及我们如何改进它的意见.
最小节点版本
GitHub 副驾驶 CLI 需要Node.js 16.0.0或更晚. 在16.0.0之前使用Node.js的版本时,可能会遇到以下错误.
usr/local/lib/node_modules/@githubnext/github-copilot-cli/dist/index.js:27
...
SyntaxError: Unexpected token '.'
at wrapSafe (internal/modules/cjs/loader.js:915:16)
at Module._compile (internal/modules/cjs/loader.js:963:27)
安装和设置
将 GitHub 副驾驶 CLI 全球安装在您的机器上 npm数字 :
$ npm install -g @githubnext/github-copilot-cli
此添加命令 github-copilot-cli 给您的 PATH。 。 。 .
要使用 GitHub 认证, 请运行以下命令 :
$ github-copilot-cli auth
并遵守屏幕指示. 一旦认证,该令牌将存储在您的机器上,并用于未来的请求,因此这个命令只需要运行的很少.
升级
要升级 GitHub 副驾驶 CLI, 运行以下命令 :
$ npm install -g @githubnext/github-copilot-cli
设置别名便利命令
您可以直接使用 GitHub 副驾驶 CLI 运行 github-copilot-cli但我们建议你安装 ??, (中文(简体) ), git?,以及 gh? 命令在你的外壳.
这些不仅更方便打字,而且 提供新增特性。 。 。 .
要安装它们, 请运行以下命令 :
eval "$(github-copilot-cli alias -- "$0")"
这些会添加命令到您的外壳中, 但仅限于当前会话 .
要在未来的所有会话中提供这些命令,您应该将以上命令单独添加到您的底部 .zshrc 或者说 .bashrc 或相当.
用法说明和提示
GitHub Copilot CLI的所有三种模式都以同样的方式运作: gitHub Copilot CLI将尝试构建命令或命令序列来完成. 如果你对建议的命令满意,请GitHub副驾驶CLI为你运行.
解释
GitHub 副驾驶 CLI 也会逐个解释建议的命令是做什么的. 当你学习新的命令或旗帜时,这一点很重要:外壳非常强大,你可能会无意中做你无意的不可逆的改变. 在运行命令之前,你一定要明白建议命令会做什么. 和所有AI系统一样,GitHub Copilot CLI也不完美,可能出错.
订正
如果命令不是你想要的,你可以修改您的查询,请 GitHub Copilot CLI 推荐一个新的命令. 这一工作流程可用于不同目的:
-
GitHub 副驾驶 CLI 误解了您最初的查询,一个修订可以让它重新走上正轨,例如.
only files in current folder。 。 。 . -
该建议适用于与你不同的平台。 使用修改来表达您的平台要求, 例如 .
on fish shell。 。 。 . -
从简单的查询开始,并迭代地使其更为复杂,例如构建多管指令或多个语句,如上所显示的视频. 这往往比在第一个查询中写出所有细节更好.
-
GitHub 副驾驶CLI可能在最初的建议中建议占位者姓名. 可以使用修改来取而代之的是您想要使用的实际名称,例如.
on branch feature/origami-swans。 。 。 .
在壳里找到的
既然你直接把询问写在外壳里 还有很多需要注意的.
许多符号在外壳中具有特殊的意义,并将被解释 在此之前 交给GitHub副驾驶CLI.
最安全的方法是在询问中完全避免这些符号.
如果你特别需要它们, 大部分可以通过前缀后缀来逃脱 \,或者用单引号附加整个查询 ' ... '。 。 。 .
例如:
-
引号
'或者说",问号?或感叹标记!在您的查询中,通常会导致 shell 语法错误,或者导致 shell 期望您查询的第二行. 在后一种情况下,按 Ctrl-C 取消当前 shell 语句,并在没有违法符号的情况下再次写出您的查询. -
括号、括号和括号
( ) [ ] { }将同样导致 shell 语法错误,或使 shell 期望您查询的第二行. -
缓存
*将扩展为匹配文件和文件夹名称。 这可能导致敏感文件名信息出现在查询中. -
烟斗
|将被解释为外壳管 并解释之后的任何东西 作为一个单独的指令。 由于GitHub Copilot CLI是交互式应用程序,这几乎肯定会失败. -
切勿预置外壳可变名称
$:这导致外壳在GitHub Copilot CLI看到它之前扩展变量,有可能在查询中发送敏感信息.
更多实例视频
git?
gh?
隐私和遥测
在使用GitHub副驾驶CLI时,我们将形成一个查询,并发送到GitHub副驾驶AI. 我们还正在收集应用软件的远程测量.
我们非常清楚,这个外壳是一个敏感的地方,可以获得很多私人信息. 请放心, GitHub 副驾驶 CLI 在查询和收集的遥测中只从您的外壳中发送少量信息 .
我们从未收集到的东西
我们是 永远 收割和发送下列任何一种:
- 您没有在查询中写入的文件和文件夹名称 .
- 您系统中任何文件的内容 .
- Git repo, 分支或状态信息
- 您外壳中设置的任何环境变量的值 .
- 你壳的指令史.
- 任何 shell 命令输出, 也不适用于您要求 GitHub Copilot CLI 运行的命令 .
这有什么意义 eval 和别名的东西?
您可能会对便利指令的环路安装指令产生疑问 ??, (中文(简体) ), git?,以及 gh?。 。 。 .
这些命令必须使用 eval 是它们本身不是可执行的,而是“贝壳函数”来包扎 github-copilot-cli。 。 。 .
这使得命令能够更紧密地与当前 shell 会话集成, 并提供运行时无法获得的两个关键特性 github-copilot-cli 直接 :
-
当您接受建议的命令时, 此命令会在当前 shell 会话中运行 . 这意味着您的命令会使用相同的 shell状态, 如环境变量, 就像您自己输入命令那样 . 这回避了许多潜在的混淆点. 事实上,当你跑的时候
github-copilot-cli直接地,我们想避免这种混淆,因此简单地打印命令,并请求您自己将命令复制/打入壳中,而不是打开子壳. -
当你接受一个建议的命令, 我们不仅运行它, 并且把它加入你的贝壳的命令历史. 这意味着,如果你想再次运行或编辑它,你可以仅仅使用上-窄或Ctrl-R来回忆.