- emberShell will not install any dependencies on Windows.
- emberShell will delete Linux specific files by default on Windows.*
- emberShell will use the newest PowerShell version available.
- if you do not have PowerShell 7+, certain features may not work.**
- certain features may not be available without Windows Terminal.***
* this behavior can be disabled by using the --preserve-linux-files flag.
** you can update PowerShell by using the --update-pwsh or --update-powershell flag.
*** you can install Windows Terminal by using the --install-wt flag.
- emberShell will only install dependencies if you specify tell it to do so in the setup.
- emberShell will delete Windows specific files if requested in the installer.
- emberShell is not maintained for MacOS right now.
- emberShell may run if you use the linux installer.
- PRs which add MacOS support will be accepted
Method 1
Right click setup.ps1 and select "Run in PowerShell".
Method 2
Open the emberShell folder in your Terminal;
you can do this by either using cd "yourpath/to/emberShell" or by entering PowerShell, pwsh or wt in the Address-bar in File Explorer.*
type in .\setup; you can also add flags to install packages or preserve non required files.
flags:
--preserve-linux-files--update-pwsh--install-wt-o**
* even when setting up emberShell in PowerShell rather than pwsh it will install onto pwsh if available.
** -o allows you to select Options in the Terminal rather than adding lots of flags.
.\setup
# you can also add flags, valid flags above.Run lnxsetup.ps1
pick your preferred options.
There is no dedicated Installer for MacOS.
emberShell may work on MacOS when manually installed.
MacOS features are not tested.
MacOS support is not planned.
the Linux guides may work; but that is not guaranteed.
your Terminal should now have an emberShell profile.
if you do NOT have a Terminal follow these steps:
press Win + R;
type in emberShell
Alternatively:
double click emberShell.bat
run emberShell.sh
MacOS is not supported by emberShell.
you will have to manually build a launcher file for it.
the Linux guides may work; but that is not guaranteed.
Manual boot:
Import-Module your/path/to/emberCore/emberCore.psm1
. your/path/to/emberCore/emberProfile.ps1
# both required to run!.esx files sometimes fail to import due to unknown reasons.
rerunning setup.ps1 usually fixes it,
if that does not work; try deleting all .ps1 files in your %TEMP% folder
if that also does not work; then try restarting your pc through terminal (shutdown /r /t 0)
Interactive Documentation can be viewed in eSh by running the command idoc
you can run specific idocs by running the command idoc document_name
legacy documentation is kept in /Documentation, though it is getting deprecated over time.