Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add support for direnv to second line #53

Merged
merged 7 commits into from
Jun 18, 2020
Merged

feat: add support for direnv to second line #53

Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
8a86e14
add direnv to zsh prompt
May 29, 2020
b74596a
add direnv display to bash
Jun 1, 2020
5bea7c2
call correct function name
Jun 1, 2020
3b0a5ad
update readme
Jun 16, 2020
86b84be
Update README.md
patrickserrano Jun 16, 2020
17bdb0b
resolving PR comments
Jun 17, 2020
17266c7
Merge branch 'add-direnv' of github.com:patrickserrano/prompt into ad…
Jun 17, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
120 changes: 107 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,22 +6,22 @@

## Vitals

Info | Badges
--------------|-------------------------------------
License | [![License][license-image]][license-uri]
License Scan | [![FOSSA Status][fossa-image]][fossa-uri]
Build | [![Build][build-image]][build-uri]
| Info | Badges |
| ------------ | ----------------------------------------- |
| License | [![License][license-image]][license-uri] |
| License Scan | [![FOSSA Status][fossa-image]][fossa-uri] |
| Build | [![Build][build-image]][build-uri] |

### Supported Operating Systems

Name | Version
-------|------------------
macOS | Sierra or greater
ubuntu | 16.04 or greater
fedora | 29 or greater
debian | 9 or greater
centOS | 7 or greater
mint | 19 or greater
| Name | Version |
| ------ | ----------------- |
| macOS | Sierra or greater |
| ubuntu | 16.04 or greater |
| fedora | 29 or greater |
| debian | 9 or greater |
| centOS | 7 or greater |
| mint | 19 or greater |

## Know It

Expand All @@ -37,6 +37,7 @@ including:
* Flush DNS (on macOS)
* Ability to enable and disable hidden files in Finder (on macOS)
* Display of available colors (already set as variables for use elsewhere)
* Display currently active Python virtialenv when using [pyenv][pyenv-url] & [direnv][direnv-url] (bash & zsh)
* ... and much more!

Note: All "extensions" are implemented as scripts added to the path, so it should not interfere with existing
Expand Down Expand Up @@ -121,6 +122,93 @@ In order to test the installation routine for promptMastermind, we use a set of
In addition, [circleci][circleci-uri] is used to build all platforms, including macOS as part of our pull request
validation. Special thanks to [circleci][circleci-uri] for providing the build agents!

## Features

### Two-Line Prompt

The first-line displays username, hostname, and current path.

The second-line emits information about the current branch and status when in a git path. If using [pyenv][pyenv-url] and [direnv][direnv-url] the second-line also displays the currently activated Python virtualenv.

### SDK Installs

[AWS SDK][aws-sdk-url]

```sh
aws-install
```

[Google Cloud SDK][gcloud-sdk-url]

```sh
gcloud-install
```

[.Net SDK][dotnet-sdk-url]

```sh
dotnet-install
```

### Colors

Glocal colors defined by promotMastermind:
sjk07 marked this conversation as resolved.
Show resolved Hide resolved
patrickserrano marked this conversation as resolved.
Show resolved Hide resolved

| Name | Color |
| ------------------ | ----------------------- |
| CLR_CLEAR | DEFAULT COLOR |
| CLR_BLACK | ANSI BLACK (GRAY) |
| CLR_RED | ANSI RED |
| CLR_GREEN | ANSI GREEN |
| CLR_YELLOW | ANSI YELLOW |
| CLR_BLUE | ANSI BLUE |
| CLR_MAGENTA | ANSI MAGENTA (PURPLE) |
| CLR_CYAN | ANSI CYAN |
| CLR_WHITE | ANSI WHITE |
| CLR_BRIGHT_BLACK | BRIGHT BLACK (GRAY) |
| CLR_BRIGHT_RED | BRIGHT RED |
| CLR_BRIGHT_GREEN | BRIGHT GREEN |
| CLR_BRIGHT_YELLOW | BRIGHT YELLOW |
| CLR_BRIGHT_BLUE | BRIGHT BLUE |
| CLR_BRIGHT_MAGENTA | BRIGHT MAGENTA (PURPLE) |
| CLR_BRIGHT_CYAN | BRIGHT CYAN |
| CLR_BRIGHT_WHITE | BRIGHT WHITE |

### macOS Commands

Show/Hide Files:

```sh
# show all hidden files
show-all

# hide all hidden files
hide-all
```

Flush DNS:

```she
patrickserrano marked this conversation as resolved.
Show resolved Hide resolved
flush-dns
```

Install [minikube][minikube-url]:

```sh
minikube-install
patrickserrano marked this conversation as resolved.
Show resolved Hide resolved
```

Set Theme to Monokai:
```sh
theme monokai # general high quality theme that has been around for many years
```

Set Theme to Dark Mode
```sh
theme dark-mode # our own custom theme that is nice and bright for dark mode on macOS
```
---

## Copyright and License

© automotiveMastermind and contributors. Distributed under the MIT license. See [LICENSE][license-uri] for details.
Expand All @@ -136,3 +224,9 @@ validation. Special thanks to [circleci][circleci-uri] for providing the build a

[fossa-image]: https://app.fossa.com/api/projects/custom%2B12139%2Fgit%40github.com%3AautomotiveMastermind%2Fprompt.git.svg?type=shield
[fossa-uri]: https://app.fossa.com/projects/custom%2B12139%2Fgit%40github.com%3AautomotiveMastermind%2Fprompt.git?ref=badge_shield
[pyenv-url]: https://github.com/pyenv/pyenv
[direnv-url]: https://github.com/direnv/direnv/wiki/Python
[minikube-url]: https://minikube.sigs.k8s.io/docs/
[aws-sdk-url]: https://github.com/aws/aws-cli
[gcloud-sdk-url]: https://cloud.google.com/sdk/install
[dotnet-sdk-url]: https://github.com/dotnet/installer