https://github.com/Ninroot/nacre

Intuitive Shell
https://github.com/Ninroot/nacre

intuitive javascript nodejs shell

Last synced: about 2 months ago
JSON representation

Intuitive Shell

• Host: GitHub
• URL: https://github.com/Ninroot/nacre
• Owner: Ninroot
• License: mit
• Created: 2022-01-21T14:03:28.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2022-06-27T15:15:54.000Z (over 2 years ago)
• Last Synced: 2024-10-05T22:46:36.384Z (3 months ago)
• Topics: intuitive, javascript, nodejs, shell
• Language: TypeScript
• Homepage: https://nacre.sh
• Size: 418 KB
• Stars: 35
• Watchers: 1
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Nacre

![version-beta](https://img.shields.io/badge/version-beta-yellow)

[Nacre](https://nacre.sh/) is an **intuitive shell** designed for those who prefer to work with **objects** over text. [Want to give it a try?](https://nacre.sh/getting-started)

## Builtins at your fingertips

Navigate smoothly with preview, completion and your favorits builtins: `ls`, `cd`, `chmod`, `chown`, `stat`, `grep`, and [more](https://nacre.sh/docs#builtins).

![builtins_black](https://user-images.githubusercontent.com/11426226/160006956-f44a6bf0-96f6-475c-93db-b42f1be230ba.gif)

## Automatic module loading

The [auto-require](https://nacre.sh/getting-started#auto-require) mechanism imports your modules when you need it. Explicit import can also be done with `require()`.

![import_back](https://user-images.githubusercontent.com/11426226/160008043-e1cfc744-182f-443c-b480-59372560abc2.gif)

## Installation

Nacre relies on NodeJS version 18, so you must have it installed on your system. Follow their [installation instructions](https://nodejs.org/). Once this is done, install it using:

```bash

npm install -g nacre

```

More [details](https://nacre.sh/getting-started#installation) about the installation.

## Example

An example is better than a long speech:

```js

> ls()

[ 'foo' ]

> touch('bar')

'bar'

> ls()

[ 'bar', 'foo' ]

  

// inspect foo's permissions

> chmod('foo')

{

  user: { read: true, write: true, execute: false },

  group: { read: true, write: false, execute: false },

  others: { read: true, write: false, execute: false }

}

> chmod.add.execute.user('foo')

{

  user: { read: true, write: true, execute: true },

  group: { read: true, write: false, execute: false },

  others: { read: true, write: false, execute: false }

}

> const perm = chmod('foo')

// inspect the value of perm variable

> perm

{

  user: { read: true, write: true, execute: true },

  group: { read: true, write: false, execute: false },

  others: { read: true, write: false, execute: false }

}

// give bar the same permissions as foo 

> chmod.set('bar', perm)

{

  user: { read: true, write: true, execute: true },

  group: { read: true, write: false, execute: false },

  others: { read: true, write: true, execute: false }

}

```

## Available commands

See the [documentation](https://nacre.sh/docs).

## Contributing

See [CONTRIBUTING.md](./CONTRIBUTING.md).

## License

MIT. See [LICENSE](./LICENSE).