https://github.com/neo-sh/neosh

A next-gen shell for modern systems (wip)
https://github.com/neo-sh/neosh

cli crossplatform dotfiles lua neosh rust shell

Last synced: about 1 month ago
JSON representation

A next-gen shell for modern systems (wip)

• Host: GitHub
• URL: https://github.com/neo-sh/neosh
• Owner: neo-sh
• License: gpl-3.0
• Created: 2021-11-05T17:39:16.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2023-01-20T23:32:49.000Z (almost 2 years ago)
• Last Synced: 2024-08-01T22:03:59.270Z (4 months ago)
• Topics: cli, crossplatform, dotfiles, lua, neosh, rust, shell
• Language: Lua
• Homepage:
• Size: 183 KB
• Stars: 66
• Watchers: 4
• Forks: 5
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• project-awesome - neo-sh/neosh - A next-gen shell for modern systems (wip) (Lua)

README

        




# Neosh

Next-gen shell built with Rust and Lua.

![Status](https://img.shields.io/badge/status-WIP-informational?style=flat-square&logo=github)

[![License](https://img.shields.io/github/license/neo-sh/neosh?style=flat-square)](https://github.com/neo-sh/neosh/blob/main/LICENSE)

[![Discord](https://img.shields.io/badge/discord-join-7289da?style=flat-square&logo=discord)](https://discord.com/invite/DRf8KkfDVE)

![Minimal Rustc version](https://img.shields.io/badge/Rustc%20version-1.59-orange?style=flat-square&logo=Rust)



## Planned features

- Customizable TUI

- Configuration powered by LuaJIT

- Well-documented API

- Plugins

- Doc system powered by [neorg](https://git.io/neorg)

- Crossplatform

- Instant config reload

- Instant reload of paradigms (profiles)

- Configurable log system

## Requirements

- `rustc` version: 1.59+

## Installation

```shell

$ git clone https://github.com/neo-sh/neosh.git

$ cd neosh

$ cargo build --profile optimized

```

## Contribution

### Ideas for contributing

- [Issues](https://github.com/neo-sh/neosh/issues)

- [Roadmap](https://github.com/neo-sh/neosh/projects/1)

### Rules for contributing

1. One PR - one feature (refactoring codebase and bugfixes can be done in a single PR)

2. [Conventional commit names](https://www.conventionalcommits.org/en/v1.0.0/)

3. One change - one commit (for example, formatting whole code should be done in separated commit)

### How to contribute

1. Fork repository

2. Create an issue about your contribution if does not exist

3. Create draft PR

4. Start coding

# Credits

Logo made by [Binx](https://github.com/binxptr)