Skip to content

Commit afe3f73

Browse files
committed
updated README.md
1 parent 732ad1e commit afe3f73

File tree

1 file changed

+25
-25
lines changed

1 file changed

+25
-25
lines changed

.bash.d/README.md

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -7,33 +7,33 @@ All `*.sh` files in this directory are automatically sourced by `.bashrc` at the
77

88
To disable any these source files, simply rename them to not match the `*.sh` glob, eg. => `*.sh.disabled`.
99

10-
* `aliases.sh` - general aliases
11-
* `functions.sh` - general functions eg. `pass` which prompts for a password which is saved to an environment variable and auto-populated in various top-level API querying scripts built on `curl_auth.sh`
12-
* `env.sh` - general environment variables and var/unvar functions for setting environment variables for the current and all new shell sessions
13-
* `paths.sh` - deduplicated adding to `$PATH` for lots of common places (eg. /usr/sbin, /usr/local/bin, ~/bin) and commands to clearly print one path per line for Bash `$PATH`, Perl `@INC` and Python `sys.path`. Also contains technology specific paths when there is no `<technology>.sh` file. All other includes use `add_PATH()` function defined here.
14-
* `<technology>.sh` - aliases, functions and environment variables to make interactive day-to-day use of a specific technologies easier
15-
* Cloud / Containerization / Virtualization:
16-
* `aws.sh` - [AWS](https://aws.amazon.com) functions:
10+
- `aliases.sh` - general aliases
11+
- `functions.sh` - general functions eg. `pass` which prompts for a password which is saved to an environment variable and auto-populated in various top-level API querying scripts built on `curl_auth.sh`
12+
- `env.sh` - general environment variables and var/unvar functions for setting environment variables for the current and all new shell sessions
13+
- `paths.sh` - deduplicated adding to `$PATH` for lots of common places (eg. /usr/sbin, /usr/local/bin, ~/bin) and commands to clearly print one path per line for Bash `$PATH`, Perl `@INC` and Python `sys.path`. Also contains technology specific paths when there is no `<technology>.sh` file. All other includes use `add_PATH()` function defined here.
14+
- `<technology>.sh` - aliases, functions and environment variables to make interactive day-to-day use of a specific technologies easier
15+
- Cloud / Containerization / Virtualization:
16+
- `aws.sh` - [AWS](https://aws.amazon.com) functions:
1717
- `aws_env` - populates credentials from `~/.aws/credentials` / `~/.boto` section given as an argument to `$AWS_ACCESS_KEY` and `$AWS_SECRET_KEY` environment variables and sets `$AWS_PROFILE` to the profile name (defaults to the 'default' profile and creds if no argument is specified)
1818
- `aws_envs` - prints the available envs configured in the aws credentials file and stars the one currently in use
1919
- `awk_token` - generates a 24-hour MFA session token, exports it as `$AWS_SESSION_TOKEN` for use with [AWS CLI](https://aws.amazon.com/cli/), and saves it to `~/.aws/token` for loading to other shells that call `aws_env`
20-
* `docker.sh` - [Docker](https://www.docker.com/) convenient aliases and functions like clearing old containers and dangling image layers to clean up space
21-
* `kubernetes.sh` - [Kubernetes](https://kubernetes.io/) aliases and functions, managing contexts and namespaces even for periodically regenerated `.kube/config` with refreshed embedded certificates, switching between open source [Kubernetes](https://kubernetes.io/) and Redhat [OpenShift](https://www.openshift.com/) `kubectl` and `oc` commands, automating getting authentication token and Kubernetes API endpoints
22-
* `vagrant.sh` - [Vagrant](https://www.vagrantup.com/) aliases and functions
23-
* Automation / Distributed Systems:
24-
* `ansible.sh` - [Ansible](https://www.ansible.com) aliases and environment variables
25-
* `kafka.sh` - [Kafka](http://kafka.apache.org/) environment variables for Kerberos security and CLI appropriate heap size (avoids heap allocation failures on VMs that otherwise default to using larger server configured heap size), avoiding need for common broker and zookeeper arguments when using `kafka_wrappers/` scripts by setting your Kafka broker and zookeeper addresses once instead of in every command
26-
* Coding:
27-
* `git.sh` - [Git](https://git-scm.com/) aliases and functions
28-
* `mercurial.sh` - [Mercurial](https://www.mercurial-scm.org/) aliases and functions
29-
* `svn.sh` - [Svn](https://subversion.apache.org) aliases and functions
30-
* `java.sh` - [Java](https://www.java.com/en/) detection and setting of `$JAVA_HOME` for Linux and Mac environments
31-
* OS:
32-
* `apple.sh` - [Apple Mac OS X / macOS](https://en.wikipedia.org/wiki/MacOS) specific tricks
33-
* `linux.sh` - [Linux](https://en.wikipedia.org/wiki/Linux) specific miscellaneous bits like X.org
34-
* `network.sh` - network aliases and functions
35-
* `ssh.sh` - SSH convenience functions and key management
36-
* `ssh-agent.sh` / `gpg-agent.sh` - auto-starts SSH and GPG agents if not already running, stores and auto-sources their details for new shells to automatically use them
37-
* `title.sh` - auto-title tricks for Screen and Terminals
20+
- `docker.sh` - [Docker](https://www.docker.com/) convenient aliases and functions like clearing old containers and dangling image layers to clean up space
21+
- `kubernetes.sh` - [Kubernetes](https://kubernetes.io/) aliases and functions, managing contexts and namespaces even for periodically regenerated `.kube/config` with refreshed embedded certificates, switching between open source [Kubernetes](https://kubernetes.io/) and Redhat [OpenShift](https://www.openshift.com/) `kubectl` and `oc` commands, automating getting authentication token and Kubernetes API endpoints
22+
- `vagrant.sh` - [Vagrant](https://www.vagrantup.com/) aliases and functions
23+
- Automation / Distributed Systems:
24+
- `ansible.sh` - [Ansible](https://www.ansible.com) aliases and environment variables
25+
- `kafka.sh` - [Kafka](http://kafka.apache.org/) environment variables for Kerberos security and CLI appropriate heap size (avoids heap allocation failures on VMs that otherwise default to using larger server configured heap size), avoiding need for common broker and zookeeper arguments when using `kafka_wrappers/` scripts by setting your Kafka broker and zookeeper addresses once instead of in every command
26+
- Coding:
27+
- `git.sh` - [Git](https://git-scm.com/) aliases and functions
28+
- `mercurial.sh` - [Mercurial](https://www.mercurial-scm.org/) aliases and functions
29+
- `svn.sh` - [Svn](https://subversion.apache.org) aliases and functions
30+
- `java.sh` - [Java](https://www.java.com/en/) detection and setting of `$JAVA_HOME` for Linux and Mac environments
31+
- OS:
32+
- `apple.sh` - [Apple Mac OS X / macOS](https://en.wikipedia.org/wiki/MacOS) specific tricks
33+
- `linux.sh` - [Linux](https://en.wikipedia.org/wiki/Linux) specific miscellaneous bits like X.org
34+
- `network.sh` - network aliases and functions
35+
- `ssh.sh` - SSH convenience functions and key management
36+
- `ssh-agent.sh` / `gpg-agent.sh` - auto-starts SSH and GPG agents if not already running, stores and auto-sources their details for new shells to automatically use them
37+
- `title.sh` - auto-title tricks for Screen and Terminals
3838

3939
More script related functions can be found in the [lib/](https://github.com/HariSekhon/DevOps-Bash-tools/tree/master/lib) directory at the top level.

0 commit comments

Comments
 (0)