Code Monkey home page Code Monkey logo

iris's Introduction

CodeFactor Grade Bash Version 4 GitHub license GitHub stars GitHub code size in bytes


A minimal, customizable prompt for bash
Report Bug Β· Request Feature
Explore the Docs

Table of Contents
  1. About iris
  2. Getting Started
  3. Usage
  4. Contributing
  5. License
  6. Authors
  7. Acknowledgements

🧐 About iris

A minimal, fast, and customizable prompt for BASH 4.0 or greater:

Minimal: No excess bloat, straight and to the point.

Customizable: Configure settings for each user, one size does not always fit all.

Hassle-free: Easy to install, easy to update (if you so chose!)

πŸš€ Getting Started

Prerequisites

  • sudo
  • git
  • wget (script install)

Optional

Installation

Install via git

sudo su -
git clone https://github.com/awildamnesiac/iris "/opt/iris"
/opt/iris/src/tools/git-install.sh

🎈 Usage

  • --config [view|set] [var] [value]
    • view or set configuration values in ~/.config/iris/iris.conf
  • --defaults
    • resets iris configuration to default
  • --disable-module [module]
    • disables the provided module
  • --enable-module [module]
    • enables the provided module
  • --help
    • displays iris help message
  • --modules
    • lists all installed/available modules
  • --reload
    • reloads iris configurations
  • --uninstall
    • uninstalls iris
  • --upgrade
    • upgrades iris to latest version
  • --version
    • outputs installed iris version

🀝 Contributing

Contributions are what make the world go around. We would love to be able to accept any new contributions, but I have not written the contribution guidelines yet.

πŸ“ƒ License

Distributed under the BSD-3-Clause License. See license for more information.

✍️ Authors

@awildamnesiac - Idea & Initial work

See the list of contributors who participated in this project.

πŸ“£ Acknowledgements

  • starship - A customizable prompt built in rust.
  • nerd-fonts - Fonts patched with a high number of development related glyphs.
  • shields - A service for concise, consistent badges.
  • codefactor - Automated code review for GitHub.
  • ohmybash - An open source, community-driven framework for managing your bash configuration.
  • ohmyzsh - A community-driven framework for managing your zsh configuration.
  • coderdocs - A free Bootstrap documentation template made for software developers.

(back to top)

iris's People

Contributors

scentedskunk avatar

Stargazers

Burak Sormageç avatar Jason Matthews avatar RXWatcher avatar  avatar  avatar

Forkers

jmsdonline

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    πŸ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. πŸ“ŠπŸ“ˆπŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❀️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.