@operatehappy/shortcuts

Shortcuts for @operatehappy

This repository is a collection of organization-specific shortcuts for @operatehappy.

Table of Contents

• Shortcuts for @operatehappy
  • Table of Contents
  • Requirements
  • Dependencies
  • Usage
  • Author Information
  • License

Requirements

This module requires Node.js 6.x or later.

Dependencies

This script has no external dependencies.

Usage

To install this utility, run the following command in your console:

npm install -g @operatehappy/shortcuts

This will make the following shortcuts available globally:

Docker

• docker-remove-dangling-volumes
• docker-remove-dead
• docker-system-prune
• docker-system-df

Git

• git-log

Terraform

• terraform-apply
• terraform-destroy
• terraform-fmt
• terraform-get
• terraform-graph
• terraform-import
• terraform-init
• terraform-plan
• terraform-refresh
• terraform-taint
• terraform-untaint
• terraform-workspace-delete
• terraform-workspace-new

The shortcuts in the Terraform section set sensible defaults that work for us. Inspect the Shell scripts for a better understanding of what that means.

pre-commit

• pre-commit-install
• pre-commit-remove
• pre-commit-run

The shortcuts in the pre-commit section install, remove, or run Git hooks using our organization-specific configuration.

Operate Happy

• oh-shfmt
• oh-release
• oh-terraform-docs

misc. stuff

• serve

This shortcut provides a quick way of serving the current directory via HTTP. The shortcut defaults to using python and maps to port 4779.

The runtime can be changed by supplying a single argument as the first argument. Valid options include: python2, python3, php, and ruby.

Author Information

This module is maintained by the contributors listed on GitHub

Development of this module was sponsored by Operate Happy.

License

Licensed under the Apache License, Version 2.0 (the "License").

You may obtain a copy of the License at apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" basis, without WARRANTIES or conditions of any kind, either express or implied.

See the License for the specific language governing permissions and limitations under the License.