loading.sh

Loading with style in the shell.

Contents - Usage | Install | Tests | License

If you'd like to jump straight to installing loading.sh, please go to the Install section or try one of these:

brew tap evnp/loading.sh && brew install loading.sh
# OR
npm install -g loading.sh
# OR to curl directly, see https://github.com/evnp/loading.sh#install

Usage

🚧 Under construction 🚧

Install

Homebrew:

brew tap evnp/loading.sh && brew install loading.sh

NPM:

npm install -g loading.sh

curl:

read -rp $'\n'"Current \$PATH:"$'\n'"${PATH//:/ : }"$'\n\n'"Enter a directory from the list above: " \
  && curl -L -o "${REPLY/\~/$HOME}/loading.sh" https://github.com/evnp/loading.sh/raw/main/loading.sh \
  && chmod +x "${REPLY/\~/$HOME}/loading.sh"

loading.sh has no external dependencies, but it's good practice to audit code before downloading.sh onto your system to ensure it contains nothing unexpected. Please view the full source code for loading.sh here: https://github.com/evnp/loading.sh/blob/master/loading.sh

If you also want to install loading.sh's man page:

read -rp $'\n'"Current \$MANPATH:"$'\n'"${MANPATH//:/ : }"$'\n\n'"Enter a directory from the list above: " \
  && curl -L -o "${REPLY/\~/$HOME}/man1/loading.sh.1" https://github.com/evnp/loading.sh/raw/main/man/loading.sh.1

Verify installation:

loading.sh -v
==> loading.sh 2.0.2

brew test loading.sh
==> Testing loading.sh
==> /opt/homebrew/Cellar/loading.sh/2.0.2/bin/loading.sh test --print 1234 hello world

Tests

Run once:

npm install
npm test

Use fswatch to re-run tests on file changes:

brew install fswatch
npm install
npm run testw

Non-OSX: replace brew install fswatch with package manager of choice (see fswatch docs)

License

MIT License

Copyright (c) 2024 Evan Campbell Purcer

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.