bgudmestad/Nushell_documentation

# Introduction

Hello, and welcome to the Nushell project.
The goal of this project is to take the Unix philosophy of shells, where pipes connect simple commands together, and bring it to the modern style of development.
Thus, rather than being either a shell, or a programming language, Nushell connects both by bringing a rich programming language and a full-featured shell together into one package.

Nu takes cues from a lot of familiar territory: traditional shells like bash, object based shells like PowerShell, gradually typed languages like TypeScript, functional programming, systems programming, and more. But rather than trying to be a jack of all trades, Nu focuses its energy on doing a few things well:

- Being a flexible cross-platform shell with a modern feel
- Solving problems as a modern programming language that works with the structure of your data
- Giving clear error messages and clean IDE support

## This Book

The book is split into chapters which are further broken down into sections.
You can click on the chapter headers to get more information about it.

- [Getting Started](getting_started.md) teaches you how to install Nushell and shows you the ropes. It also explains some of the design principles where Nushell differs from typical shells, such as bash.
- [Nu Fundamentals](nu_fundamentals.md) explains basic concepts of the Nushell language.
- [Programming in Nu](programming_in_nu.md) dives more deeply into the language features and shows several ways how to organize and structure your code.
- [Nu as a Shell](nu_as_a_shell.md) focuses on the shell features, most notably the configuration and environment.
- [Coming to Nu](coming_to_nu.md) is intended to give a quick start for users coming from other shells or languages.
- [Design Notes](design_notes.md) has in-depth explanation of some of the Nushell's design choices.
- [(Not So) Advanced](advanced.md) includes some more advanced topics (they are not _so_ advanced, make sure to check them out, too!).

## The Many Parts of Nushell

The Nushell project consists of multiple different repositories and subprojects.
You can find all of them under [our organization on GitHub](https://github.com/nushell).

- The main Nushell repository can be found [here](https://github.com/nushell/nushell). It is broken into multiple crates that can be used as independent libraries in your own project, if you wish so.
- The repository of our [nushell.sh](https://www.nushell.sh) page, including this book, can be found [here](https://github.com/nushell/nushell.github.io).
- Nushell has its own line editor which [has its own repository](https://github.com/nushell/reedline)
- [`nu_scripts`](https://github.com/nushell/nu_scripts) is a place to share scripts and modules with other users until we have some sort of package manager.
- [Nana](https://github.com/nushell/nana) is an experimental effort to explore graphical user interface for Nushell.
- [Awesome Nu](https://github.com/nushell/awesome-nu) contains a list of tools that work with the Nushell ecosystem: plugins, scripts, editor extension, 3rd party integrations, etc.
- [Nu Showcase](https://github.com/nushell/showcase) is a place to share works about Nushell, be it blogs, artwork or something else.
- [Request for Comment (RFC)](https://github.com/nushell/rfcs) serves as a place to propose and discuss major design changes. While currently under-utilized, we expect to use it more as we get closer to and beyond 1.0.

## Contributing

We welcome contributions!
[As you can see](#the-many-parts-of-nushell), there are a lot of places to contribute to.
Most repositories contain `CONTRIBUTING.md` file with tips and details that should help you get started (if not, consider contributing a fix!).

Nushell itself is written in [Rust](https://www.rust-lang.org).
However, you do not have to be a Rust programmer to help.
If you know some web development, you can contribute to improving this website or the Nana project.
[Dataframes](dataframes.md) can use your data processing expertise.

If you wrote a cool script, plugin or integrated Nushell somewhere, we'd welcome your contribution to `nu_scripts` or Awesome Nu.
Discovering bugs with reproduction steps and filing GitHub issues for them is a valuable help, too!
You can contribute to Nushell just by using Nushell!

Since Nushell evolves fast, this book is in a constant need of updating.
Contributing to this book does not require any special skills aside from a basic familiarity with Markdown.
Furthermore, you can consider translating parts of it to your language.

## Community

The main place to discuss anything Nushell is our [Discord](https://discord.com/invite/NtAbbGn).
You can also follow us on [Twitter](https://twitter.com/nu_shell) for news and updates.
Finally, you can use the GitHub discussions or file GitHub issues.

# 简介
你好，欢迎来到Nushell项目。
本项目的目标是汲取Unix shell的哲学理念——通过管道将简单命令串联起来，并将其融入现代开发范式之中。因此，Nushell并非单纯的shell或编程语言，而是将功能丰富的编程语言与全功能shell融为一体，打包为单一工具。

Nu借鉴了诸多成熟方案的设计思路：诸如bash这类传统shell、PowerShell这类面向对象的shell、TypeScript这类渐进式类型语言，以及函数式编程、系统编程等诸多领域的经验。不过，Nu并未追求成为全能型工具，而是专注于在以下几个方面做到极致：
- 打造兼具灵活性与现代质感的跨平台shell
- 作为契合数据结构的现代化编程语言解决实际问题
- 提供清晰易懂的错误提示与完善的IDE支持

## 本书说明
本书按章节划分，各章节又进一步拆分为小节。你可点击章节标题获取对应内容的详细信息。
- [快速上手](getting_started.md)：讲解Nushell的安装方法与基础操作流程，同时阐释Nushell与bash等典型shell的设计理念差异。
- [Nu基础入门](nu_fundamentals.md)：介绍Nushell语言的核心基础概念。
- [Nu编程实践](programming_in_nu.md)：深入剖析语言特性，并展示多种代码组织与架构设计的方法。
- [作为shell的Nu](nu_as_a_shell.md)：聚焦shell相关功能，重点讲解配置与环境相关内容。
- [迁移至Nu](coming_to_nu.md)：为来自其他shell或编程语言的用户提供快速上手指南。
- [设计理念解析](design_notes.md)：深入阐释Nushell的部分核心设计决策。
- [（并不）进阶](advanced.md)：涵盖部分进阶主题（这些主题并非"过于高深"，欢迎你一同探索学习）。

## Nushell的组成部分
Nushell项目包含多个独立的代码仓库与子项目，所有项目均可在[我们的GitHub组织页面](https://github.com/nushell)中找到。
- 主仓库地址为[此处](https://github.com/nushell/nushell)，其内部拆分为多个crate（Rust包），若有需要，你可将这些包作为独立库集成至自己的项目中。
- 包含本书在内的[nushell.sh官网](https://www.nushell.sh)仓库，地址为[此处](https://github.com/nushell/nushell.github.io)。
- Nushell拥有专属的行编辑器，其独立仓库地址为[此处](https://github.com/nushell/reedline)
- [`nu_scripts`](https://github.com/nushell/nu_scripts)：在官方包管理器上线前，该仓库用于与社区分享脚本与模块。
- [Nana](https://github.com/nushell/nana)：用于探索Nushell图形用户界面的实验性项目。
- [Awesome Nu](https://github.com/nushell/awesome-nu)：收录适配Nushell生态的各类工具列表，涵盖插件、脚本、编辑器扩展、第三方集成等内容。
- [Nu作品展示](https://github.com/nushell/showcase)：用于分享与Nushell相关的各类创作，包括博客、艺术作品等。
- [征求意见稿（RFC，Request for Comment）](https://github.com/nushell/rfcs)：用于提出并讨论重大设计变更的平台。尽管目前该仓库的使用频率尚不高，但在1.0版本及后续迭代中，我们预计其使用率会逐步提升。

## 贡献指南
我们热烈欢迎各类贡献！
正如[前文所述](#the-many-parts-of-nushell)，Nushell生态拥有诸多可供贡献的方向。大多数仓库均包含`CONTRIBUTING.md`文件，其中提供了帮助你快速上手的实用建议与细节说明（若缺失该文件，欢迎你提交修复PR）。

Nushell主体采用[Rust](https://www.rust-lang.org)语言编写，但你无需掌握Rust即可参与贡献。如果你熟悉Web开发，可协助改进本官网或Nana项目。[数据帧（Dataframes）](dataframes.md)相关功能也亟需数据处理领域的专业人才参与开发。

如果你编写了实用的脚本、插件，或是将Nushell集成至了其他项目中，欢迎你将相关内容提交至`nu_scripts`仓库或Awesome Nu列表中。
发现bug并提供可复现步骤，随后在GitHub提交issue，同样是极具价值的贡献。甚至仅仅是日常使用Nushell，也是对项目的一种支持。

鉴于Nushell迭代速度较快，本书也需要持续更新维护。为本书贡献内容仅需掌握基础的Markdown语法即可。此外，你也可以考虑将本书的部分内容翻译为其他语言。

## 社区交流
Nushell相关讨论的主要平台为[Discord社区](https://discord.com/invite/NtAbbGn)。你也可以通过[Twitter](https://twitter.com/nu_shell)关注我们获取最新动态与资讯。此外，你还可使用GitHub讨论区或提交GitHub issue进行交流。

原始信息汇总

Nushell 项目概述

项目目标

Nushell 项目旨在将 Unix 哲学中的 shell 理念与现代开发风格相结合，创造一个既不是传统 shell 也不是编程语言，而是将丰富的编程语言和功能齐全的 shell 结合在一起的工具。

项目特点

• 跨平台现代 shell：提供灵活的跨平台 shell，具有现代感。
• 现代编程语言：解决数据结构问题的现代编程语言。
• 清晰的错误消息和 IDE 支持。

项目组成部分

Nushell 项目包含多个不同的仓库和子项目：

• 主仓库：Nushell，包含多个可独立使用的库。
• 官方网站和文档：nushell.sh 及其仓库 nushell.github.io。
• 行编辑器：Reedline。
• 脚本共享：nu_scripts。
• 图形界面实验：Nana。
• 生态系统工具列表：Awesome Nu。
• 展示区：Nu Showcase。
• 设计变更讨论：RFC。

贡献指南

欢迎贡献，项目包含多个部分，每个部分都有 CONTRIBUTING.md 文件提供详细信息。Nushell 本身使用 Rust 编写，但也欢迎其他技能的贡献者，如网页开发、数据处理等。

社区交流

主要交流平台是 Discord，也可关注 Twitter 获取新闻和更新，或使用 GitHub 讨论和提交问题。