RGBCube/crash
1
Fork 0
mirror of https://github.com/RGBCube/crash synced 2025-07-27 08:27:44 +00:00
Code Issues Activity Actions

Add common mistakes section

Browse source
This commit is contained in:
RGBCube 2024-05-15 14:06:47 +03:00
parent 0b88386484
commit 2cfed82a3e
No known key found for this signature in database
1 changed files with 35 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

40
README.md
View file

@ -6,14 +6,16 @@ Crash is a super lightweight shim that executes the shells that are seperated by
in your `SHELLS` environment variable in order, halting execution if one exits in your `SHELLS` environment variable in order, halting execution if one exits
sucessfully (with a 0 exit code). sucessfully (with a 0 exit code).
If you don't have anything in your `SHELLS` environment variable, Crash will If you don't have anything in your `SHELLS` environment variable or all the ones
use the fallback shell that is configured at compile time (by default, this is that did exist failed to launch, Crash will use the fallback shell that is
`bashInteractive` from nixpkgs, however you can change this by overriding the configured at compile time (by default, this is `bashInteractive` from nixpkgs,
`fallbackShell` call option). however you can change this by overriding the `fallbackShell` call option).
## Why? ## Why?
- To allow users to configure their own shells without superuser access. - To allow users to configure their own shells without superuser access (You can
set the `SHELLS` variable to something like `.config/shell` and let users
change that file).
- To have a fallback shell in case your primary one, which is your login shell, - To have a fallback shell in case your primary one, which is your login shell,
breaks and you don't want to get locked out (especially useful when using new breaks and you don't want to get locked out (especially useful when using new
unstable shells like Nushell). unstable shells like Nushell).
@ -92,6 +94,34 @@ $ SHELLS="fish:nu:bash:dash" ssh user@host
This will launch you into fish, if that fails, into nu and so on... This will launch you into fish, if that fails, into nu and so on...
## Common Misakes
### Using `~` in the `SHELLS` variable
So, the way `SHELLS` is handled is like so:
1. Split the variable into a list of shells using `:`.
2. Searches PATH for the shell, invokes it if it can find it there.
3. If it can't find the shell there, assumes the shell is a file.
If it is an absolute path, it directly invokes the executable, if
it isn'it, joins the path with the current working directory before executing.
Did you notice something? Yup, it doesn't expand the tilde (`~`)!
But no worries, you don't need it anyway as the PWD of your login shell
(in this case, Crash) is always your home directory. So if you wanted to do
```shell
SHELLS=~/.config/shell # Won't work!
```
You can do:
```shell
SHELLS=.config/shell # WILL work!
```
Instead and it will work perfectly fine.
## Credits ## Credits
- [noshell](https://github.com/viperML/noshell): This was the primary source of - [noshell](https://github.com/viperML/noshell): This was the primary source of