Nushell
安装 Nu !
快速开始
  • Nushell 之书
  • 命令参考列表
  • 实战指南
  • 语言参考指南
  • 贡献指南
博客
  • English
  • 中文
  • Deutsch
  • Français
  • Español
  • 日本語
  • Português do Brasil
  • Русский язык
  • 한국어
GitHub
安装 Nu !
快速开始
  • Nushell 之书
  • 命令参考列表
  • 实战指南
  • 语言参考指南
  • 贡献指南
博客
  • English
  • 中文
  • Deutsch
  • Français
  • Español
  • 日本語
  • Português do Brasil
  • Русский язык
  • 한국어
GitHub
  • 简介
  • 安装
    • 默认 Shell
  • 快速入门
    • 快速入门
    • 在系统中四处移动
    • 用 Nu 的方式思考
    • Nushell 速查表
  • Nu 基础篇
    • 数据类型
    • 加载数据
    • 管道
    • 处理字符串
    • 处理列表
    • 处理记录
    • 处理表格
    • 导航和访问结构化数据
    • 特殊变量
  • Nushell 编程
    • 自定义命令
    • 别名
    • 运算符
    • 变量
    • 控制流
    • 脚本
    • 模块
      • 使用模块
      • 创建模块
    • 覆层
    • 排序
    • 测试你的 Nushell 代码
    • 脚本调试
    • 最佳实践
  • Nu 作为 Shell 使用
    • 配置
    • 环境
    • 标准输出、标准错误和退出码
    • 运行系统(外部)命令
    • 如何配置第三方提示
    • 目录栈
    • Reedline,Nu 的行编辑器
    • 自定义补全
    • 外部命令
    • Nu 的配色和主题
    • 钩子
    • 后台任务
  • 迁移到 Nu
    • 从 Bash 到 Nu
    • 从 CMD.EXE 到 Nu
    • 从 PowerShell 到 Nu
    • 从其他 Shell 或 DSL 到 Nu
    • 从命令式语言到 Nu
    • 从函数式语言到 Nu
    • Nushell 运算符对照
  • 设计说明
    • Nushell代码执行原理
  • (不怎么)高级篇
    • 标准库
    • Dataframes
    • 元数据
    • 创建你自己的错误
    • 并行
    • 插件
    • explore
    • 使用 tui 构建终端用户界面
    • MCP 服务器

标准库

Nushell 内置了一个标准库,其中包含用原生 Nu 编写的实用命令。默认情况下,标准库会在 Nushell 启动时加载到内存中(但不会自动导入)。小型模块 std/prelude 是个例外:它会自动导入,提供 banner 和 pwd 命令。

  • 概述
  • 导入标准库
    • 导入子模块
  • 标准库候选模块
  • 禁用标准库
  • 在模块中使用 std/log
  • 优化启动时间

概述

标准库目前包含:

  • 断言
  • 支持补全的替代 help 系统
  • 额外的 JSON 变体格式
  • XML 访问
  • 日志记录
  • 以及其他功能

要查看标准库中所有可用命令的完整列表,可以运行以下命令:

nu -c "
  use std
  scope commands
  | where name =~ '^std '
  | select name description extra_description
  | wrap 'Standard Library Commands'
  | table -e
"

注

上面的 use std 命令会加载整个标准库,以便一次性查看所有命令。这通常不是标准的使用方式(更多信息见下文)。该命令在一个单独的 Nu 子 shell 中运行,这样就不会加载到你正在使用的 shell 作用域中。

导入标准库

标准库模块和子模块可以通过 use 命令导入,就像其他模块一样。更多信息请参考使用模块。

在命令行工作时,使用以下方式加载整个标准库会很方便:

use std *

但是,在自定义命令和脚本中应避免这种形式,因为它的加载时间最长。

使用标准库时的优化启动

请参阅下面的说明以确保你的配置不会加载整个标准库。

导入子模块

标准库的每个子模块都可以单独加载。再次强调,为了获得最佳性能,只加载代码中需要的子模块。

关于使用模块的一般信息,请参阅导入模块。下面是标准库各子模块的推荐导入方式:

1. 使用 <command> <subcommand> 形式的子模块

这些子模块通常使用 use std/<submodule> 导入(不带通配符/*):

  • use std/assert: assert 及其子命令
  • use std/bench: 基准测试命令 bench
  • use std/clip: clip copy52 和 clip paste52,通过终端(OSC 52)复制到系统剪贴板或从中粘贴;以及 clip prefix,为待复制内容的每一行添加前缀
  • use std/config: config dark-theme 和 config light-theme(用于 $env.config.color_config 的主题),以及 config env-conversions
  • use std/dirs: 目录栈命令 dirs 及其子命令
  • use std/input: input display 命令
  • use std/help: 支持补全和其他功能的替代版 help 命令及其子命令
  • use std/iter: 额外的 iter 前缀迭代命令,例如 iter find 和 iter scan
  • use std/log: log <subcommands> 如 log warning <msg>
  • use std/math: 数学常量如 $math.E。这些也可以像下面的形式 #2 那样作为定义导入
  • use std/random: random dice 命令

提示

Nushell 还提供实验性的内置命令 clip copy 和 clip paste,它们直接使用操作系统的剪贴板,而不是 OSC 52。要试用它们,请用 nu --experimental-options '[native-clip]' 启动 Nushell。

2. 直接导入模块的定义(内容)

有些子模块在将其定义(命令、别名、常量等)加载到当前作用域时更容易使用。例如:

use std/formats *
ls | to jsonl

通常使用 use std/<submodule> * (带通配符/*)导入的子模块:

  • use std/dt *: 处理 datetime 值的额外命令
  • use std/formats *: 额外的 to 和 from 格式转换
  • use std/math *: 不带前缀的数学常量,如 $E。注意上面的形式 #1 在阅读和维护代码时可能更易理解
  • use std/testing *: 用于标记测试的 @test、@ignore、@before-each、@before-all、@after-each 和 @after-all 属性
  • use std/util *: 各种实用命令,例如 path add、repeat、null-device 和 structure
  • use std/xml *: 处理 XML 数据的额外命令

3. use std <submodule>

也可以使用空格分隔的形式导入标准库子模块:

use std formats *

重要

如使用模块中所述,这种形式(像 use std * 一样)会先将整个标准库加载到作用域中,然后再导入子模块。相比之下,上面的 #1 和 #2 中的斜杠分隔版本只会导入子模块,因此会快得多。

这种形式也不适用于包含同名命令的子模块。例如,use std log 只导入 log 命令本身,不会导入 log info 或其他子命令。请改用 use std/log。

标准库候选模块

std-rfc 位于 nushell 仓库,作为标准库可能的添加项的暂存区。

std-rfc 随 Nushell 一同提供,因此可以像导入标准库子模块一样导入它的子模块,例如 use std-rfc/str。它目前包含 conversions、date、iter、kv、path、pb、random、str、tables、url 和 xml 子模块。

如果你有兴趣为标准库添加内容,请通过 PR 提交代码到该仓库的 std-rfc 模块。我们也鼓励你试用这些候选命令并提供反馈。

更多详情

标准库的候选命令通常应该:

  • 具有广泛的吸引力 - 对大量用户或用例有用
  • 编写良好并有清晰的注释,便于未来维护
  • 实现带有使用示例的帮助注释
  • 包含说明为什么你认为该命令应该成为标准库的一部分。可以将其视为一种"广告",说服人们尝试该命令并提供反馈,以便将来可以推广

为了使一个命令从 RFC 升级为标准库,它必须满足:

  • 获得积极反馈
  • 几乎没有(或没有)未解决的问题,当然也没有重大问题
  • 有提交 std 的 PR 作者。这不一定是命令的原始作者
  • 作为 std 提交 PR 的一部分包含测试用例

最终,核心团队成员将根据这些标准决定是否以及何时将命令合并到 std 中。

当然,如果 std-rfc 中的候选命令不再工作或有太多问题,可能会从中移除或禁用。

禁用标准库

要禁用标准库,可以这样启动 Nushell:

nu --no-std-lib

在使用 nu -c 在子 shell 中运行命令时,这尤其有助于减少开销。使用 -c 时,$nu.startup-time 表示 Nushell 在运行命令之前的启动耗时,因此可以比较两种方式:

nu --no-std-lib -n -c "$nu.startup-time"
# => 9ms 650µs 250ns

nu -n -c "$nu.startup-time"
# => 11ms 558µs 83ns

当以这种方式禁用时,你将无法导入标准库、它的任何子模块或使用它的任何命令,包括 std/prelude 中的 banner 和 pwd。

在模块中使用 std/log

重要!

std/log 会导出环境变量。要在你自己的模块中使用 std/log 模块,请参阅"创建模块"章节中的这个注意事项。

优化启动时间

如果 Nushell 的启动时间对你的工作流程很重要,请检查 config.nu、env.nu 和其他可能的启动配置中对标准库的低效使用。以下命令可以帮助识别问题区域:

view files
| enumerate | flatten
| where filename !~ '^std'
| where filename !~ '^repl_entry'
| where {|file|
    (view span $file.start $file.end) =~ 'use\s+std(\s|;|$)'
  }

编辑这些文件,使用上面导入子模块部分推荐的语法。

注

如果 Nushell 库(例如来自 nu_scripts 仓库)、示例或文档仍在使用这种语法,请通过 issue 或 PR 报告。

如果第三方模块使用了这种语法,请报告给作者/维护者进行更新。

在GitHub上编辑此页面
Contributors: voyage200🍬, Jianjun Wang, passionworkeer
Prev
(没那么)高级
Next
Dataframes