https://github.com/jwillikers/nushell-config
My configuration for Nushell
https://github.com/jwillikers/nushell-config
carapace config git nu nushell shell starship
Last synced: about 1 year ago
JSON representation
My configuration for Nushell
- Host: GitHub
- URL: https://github.com/jwillikers/nushell-config
- Owner: jwillikers
- License: other
- Archived: true
- Created: 2023-05-16T00:27:34.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-09-30T17:26:33.000Z (over 1 year ago)
- Last Synced: 2025-04-06T21:52:13.716Z (about 1 year ago)
- Topics: carapace, config, git, nu, nushell, shell, starship
- Language: Nushell
- Homepage: https://codeberg.org/jwillikers/nushell-config
- Size: 47.9 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.adoc
- License: LICENSE.adoc
- Code of conduct: CODE_OF_CONDUCT.adoc
Awesome Lists containing this project
README
= Nushell Config
Jordan Williams
:experimental:
:icons: font
ifdef::env-github[]
:tip-caption: :bulb:
:note-caption: :information_source:
:important-caption: :heavy_exclamation_mark:
:caution-caption: :fire:
:warning-caption: :warning:
endif::[]
:carapace-bin: https://rsteube.github.io/carapace-bin/carapace-bin.html[carapace-bin]
:direnv: https://direnv.net/[direnv]
:just: https://github.com/casey/just[just]
:nu-scripts: https://github.com/nushell/nu_scripts[nu_scripts]
:nupm: https://github.com/nushell/nupm[nupm]
:Nushell: https://nushell.sh/[Nushell]
:Starship: https://starship.rs/[Starship]
My configuration for {Nushell}.
== Usage
This repository contains the configuration files for {Nushell}.
This file is synchronized using this Git repository.
The following instructions detail how to use and sync this repository.
=== Install
Some packages need to be installed before using this configuration.
My Nushell configuration relies on a couple of other utilities: {carapace-bin} for completions, {Starship} for the prompt configuration, and {direnv} for automatic environment set up.
Both {nupm} and {nu_scripts} are also incorporated as part of the installation.
The following instructions install these along with Nushell itself.
. Follow the install instructions in the https://github.com/jwillikers/starship-config[Starship config repository] to configure the prompt.
. Install {just} by following the instructions in the https://github.com/casey/just?tab=readme-ov-file#installation[installation section].
. Clone this repository.
+
[,sh]
----
git clone git@codeberg.org:jwillikers/nushell-config.git
----
. Change to the project's directory.
+
[,sh]
----
cd nushell-config
----
. Run `just` to install everything.
+
[,sh]
----
just
----
. On Fedora Atomic systems, reboot for the changes to take effect.
+
[,sh]
----
sudo systemctl reboot
----
. Open a new shell to complete the installation.
== Code of Conduct
Please refer to the project's link:CODE_OF_CONDUCT.adoc[Code of Conduct].
== License
This repository is licensed under the https://www.gnu.org/licenses/gpl-3.0.html[GPLv3].
Please refer to the bundled link:LICENSE.adoc[license].
== Copyright
© 2023-2024 Jordan Williams
== Authors
mailto:{email}[{author}]