Skip to content
Permalink

Comparing changes

Choose two branches to see what’s changed or to start a new pull request. If you need to, you can also or learn more about diff comparisons.

Open a pull request

Create a new pull request by comparing changes across two branches. If you need to, you can also . Learn more about diff comparisons here.
base repository: trybash/bash-emulator
Failed to load repositories. Confirm that selected base ref is valid, then try again.
Loading
base: gh-pages
Choose a base ref
...
head repository: reef-technologies/bash-emulator
Failed to load repositories. Confirm that selected head ref is valid, then try again.
Loading
compare: gh-pages
Choose a head ref
Checking mergeability… Don’t worry, you can still create the pull request.
5 contributors
Loading
8 changes: 6 additions & 2 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -84,14 +84,17 @@ for bundling and minification in your own workflow.
- Returns a Promise with a command, is `undefined` if no completion found
- `commands`
- An object with all commands that the emulator knows of
- `aliases`
- An object with all aliases that the emulator knows of
- `state`
- [See below](#the-state-object)


### Built-in features, commands and flags
### Built-in features, commands, aliases and flags

- pipes `|`
- `ls -l -a`
- `ll` (an alias of `ls -l`)
- `cd`
- `pwd`
- `history`
@@ -110,6 +113,8 @@ __It's not recommended to access the state directly. Use the above defined helpe

- `history` an array of strings containing previous commands
- `user` name of the current user (defaults to `"user"`)
- `group` name of the current group (defaults to `"group"`)
- `host` name of the current host (defaults to `"localhost"`)
- `workingDirectory` a string containing the current working directory (defaults to `/home/user`)
- `fileSystem` an object that maps from absolute paths to directories or files.
- Each value has a `type` property thats either `'dir'` or `'file'`
@@ -165,7 +170,6 @@ The API of the methods are designed to work with asynchronous implementations as
- Make sure you have [node.js](https://nodejs.org/) installed
- Setup project using `npm install`
- Make sure tests are passing using `npm test`
- Build the `bash-emulator.min.js` file with `npm run build`


## Contribution
Loading