Alexandre_1a/GoSH
1
0
Fork 0
mirror of https://github.com/Alexandre1a/GoSH.git synced 2026-03-09 19:19:46 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Alexandre1a 2025-01-31 18:52:51 +01:00 committed by GitHub
parent f43bcb2954
commit 7dcafec92c
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 16 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
README.md
View File

@ -13,19 +13,26 @@ If not, the issue will be fixed soon (in case of a typo for example)
## Installation ## Installation
You can grab the binaries for your system and architecture, or build it yourself You can grab the binaries for your system and architecture, or build it yourself
To build it, clone the repository, cd into it and run To build it, clone the repository, cd into it and run
'go build -o bin/GoSH' `go build -o bin/GoSH`
To test the shell and see if it suits you. To test the shell and see if it suits you.
If everything works, then move the binary to a place inside your path. If everything works, then move the binary to a place inside your path.
To directly install it with the Go toolchain, just use 'go intall' To directly install it with the Go toolchain, just use
This will build and place the binary inside your $HOME/go/bin folder. `go intall`
This will build and place the binary inside your `$HOME/go/bin` folder.
Add this folder to your path and you are good to go ! Add this folder to your path and you are good to go !
## Usage ## Usage
To use the program, just invoke it with 'GoSH' To use the program, just invoke it with `GoSH`
If you see a message about a config file, create '~/.config/gosh/gosh_config.toml' and populate it with the defaults written inside this repo. If you see a message about a config file, create `~/.config/gosh/gosh_config.toml` and populate it with the defaults written inside this repo -> [here](/defaults.toml).
To change config parameter on the fly, use the 'set' builtin. To change config parameter on the fly, use the `set` builtin.
Currently, 'set' has a limited amount of configuration options. Currently, `set` has a limited amount of configuration options and need to have a valid config file to write to.
To change the color of the prompt use 'set color <color>' To change the color of the prompt use `set color <color>`
You can use all "console colors", listed [https://gist.github.com/kamito/704813 | here] You can change the history size with `set history_size <int>`
You can change the prompt with `set prompt <promp>`
Here is some exemple of prompts :
- `[{dir}] > `
- `["Hello World"] $ `
- `"Hello" `
You can use all "console colors", listed [here](https://gist.github.com/kamito/704813)