Merge pull request #742 from cheat/dependabot/go_modules/github.com/cloudflare/circl-1.3.7

chore(deps): bump github.com/cloudflare/circl from 1.3.6 to 1.3.7

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,23 @@
+---
+name: Bug report
+about: Submit a bug report
+title: ''
+labels: 'bug'
+assignees: ''
+
+---
+
+Thanks for submitting a bug report. Please provide the following information:
+
+**A description of the problem**
+Describe the problem here.
+
+**cheat version info**
+Please paste the output of `cheat -v` here.
+
+**cheat configuration info**
+If your bug pertains to how cheatsheets are loaded and/or displayed, please
+paste here the following information:
+
+1. The output of `cheat -d`
+2. The contents of your `conf.yml` file

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: 'enhancement'
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/dependabot.yml

@@ -0,0 +1,11 @@
+version: 2
+updates:
+- package-ecosystem: gomod
+  directory: "/"
+  schedule:
+    interval: daily
+  open-pull-requests-limit: 10
+  ignore:
+  - dependency-name: github.com/alecthomas/chroma
+    versions:
+    - 0.9.1

.github/workflows/build.yml

@@ -0,0 +1,46 @@
+---
+name: Go
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+
+jobs:
+  # TODO: is it possible to DRY out these jobs? Aside from `runs-on`, they are
+  # identical.
+  # See: https://github.com/actions/runner/issues/1182
+  build-linux:
+    runs-on: [ubuntu-latest]
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Go
+        uses: actions/setup-go@v2
+        with:
+          go-version: 1.19
+      - name: Set up Revive (linter)
+        run: go get -u github.com/boyter/scc github.com/mgechev/revive
+        env:
+          GO111MODULE: "off"
+      - name: Build
+        run: make build
+      - name: Test
+        run: make test
+
+  build-osx:
+    runs-on: [macos-latest]
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Go
+        uses: actions/setup-go@v2
+        with:
+          go-version: 1.19
+      - name: Set up Revive (linter)
+        run: go get -u github.com/boyter/scc github.com/mgechev/revive
+        env:
+          GO111MODULE: "off"
+      - name: Build
+        run: make build
+      - name: Test
+        run: make test

.github/workflows/codeql-analysis.yml

@@ -0,0 +1,30 @@
+---
+name: CodeQL
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+  schedule:
+    - cron: '45 23 * * 0'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [go]
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v2
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@v1
+        with:
+          languages: ${{ matrix.language }}
+      - name: Autobuild
+        uses: github/codeql-action/autobuild@v1
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@v1

.github/workflows/homebrew.yml

@@ -0,0 +1,19 @@
+---
+name: homebrew
+
+on:
+  push:
+    tags: '*'
+
+jobs:
+  homebrew:
+    name: Bump Homebrew formula
+    runs-on: ubuntu-latest
+    steps:
+      - uses: mislav/bump-homebrew-formula-action@v1
+        with:
+          # A PR will be sent to github.com/Homebrew/homebrew-core to update
+          # this formula:
+          formula-name: cheat
+        env:
+          COMMITTER_TOKEN: ${{ secrets.COMMITTER_TOKEN }}

.gitignore

@@ -1,2 +1,2 @@
-*.pyc
-build
+dist
+tags

CHANGELOG

@@ -1,3 +0,0 @@
-Changelog
-=========
-

CONTRIBUTING.md

@@ -0,0 +1,48 @@
+CONTRIBUTING
+============
+Do you want to contribute to `cheat`? There are a few ways to help:
+
+#### Submit a cheatsheet ####
+Do you have a witty bash one-liner to share? [Open a pull-request][pr] against
+the [cheatsheets][] repository. (The `cheat` executable source code lives in
+[cheat/cheat][cheat]. Cheatsheet content lives in
+[cheat/cheatsheets][cheatsheets].)
+
+#### Report a bug ####
+Did you find a bug? Report it in the [issue tracker][issues]. (But before you
+do, please look through the open issues to make sure that it hasn't already
+ been reported.)
+
+#### Add a feature ####
+Do you have a feature that you'd like to contribute? Propose it in the [issue
+tracker][issues] to discuss with the maintainer whether it would be considered
+for merging.
+
+`cheat` is mostly mature and feature-complete, but may still have some room for
+new features. See [HACKING.md][hacking] for a quick-start guide to `cheat`
+development.
+
+#### Add documentation ####
+Did you encounter features, bugs, edge-cases, use-cases, or environment
+considerations that were undocumented or under-documented? Add them to the
+[wiki][]. (You may also open a pull-request against the `README`, if
+appropriate.)
+
+Do you enjoy technical writing or proofreading? Help keep the documentation
+error-free and well-organized.
+
+#### Spread the word ####
+Are you unable to do the above, but still want to contribute? You can help
+`cheat` simply by telling others about it. Share it with friends and coworkers
+that might benefit from using it.
+
+#### Pull Requests ####
+Please open all pull-requests against the `develop` branch.
+
+
+[cheat]: https://github.com/cheat/cheat
+[cheatsheets]: https://github.com/cheat/cheatsheets
+[hacking]: HACKING.md
+[issues]: https://github.com/cheat/cheat/issues 
+[pr]: https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork
+[wiki]: https://github.com/cheat/cheat/wiki

Dockerfile

@@ -0,0 +1,8 @@
+# NB: this image isn't used anywhere in the build pipeline. It exists to
+# conveniently facilitate ad-hoc experimentation in a sandboxed environment
+# during development.
+FROM golang:1.15-alpine
+
+RUN apk add git less make
+
+WORKDIR /app

HACKING.md

@@ -0,0 +1,57 @@
+Hacking
+=======
+The following is a quickstart guide for developing `cheat`.
+
+## 1. Install system dependencies
+Before you begin, you must install a handful of system dependencies. The
+following are required, and must be available on your `PATH`:
+
+- `git`
+- `go` (>= 1.17 is recommended)
+- `make`
+
+The following dependencies are optional:
+- `docker`
+- `pandoc` (necessary to generate a `man` page)
+
+## 2. Install utility applications
+Run `make setup` to install `scc` and `revive`, which are used by various
+`make` targets.
+
+## 3. Development workflow
+After your environment has been configured, your development workflow will
+resemble the following:
+
+1. Make changes to the `cheat` source code.
+2. Run `make test` to run unit-tests.
+3. Fix compiler errors and failing tests as necessary.
+4. Run `make`. A `cheat` executable will be written to the `dist` directory.
+5. Use the new executable by running `dist/cheat <command>`.
+6. Run `make install` to install `cheat` to your `PATH`.
+7. Run `make build-release` to build cross-platform binaries in `dist`.
+8. Run `make clean` to clean the `dist` directory when desired.
+
+You may run `make help` to see a list of available `make` commands.
+
+### Developing with docker
+It may be useful to test your changes within a pristine environment. An
+Alpine-based docker container has been provided for that purpose.
+
+If you would like to build the docker container, run:
+```sh
+make docker-setup
+```
+
+To shell into the container, run:
+```sh
+make docker-sh
+```
+
+The `cheat` source code will be mounted at `/app` within the container.
+
+If you would like to destroy this container, you may run:
+```sh
+make distclean
+```
+
+[go]: https://go.dev/

INSTALLING.md

@@ -0,0 +1,79 @@
+Installing
+==========
+`cheat` has no runtime dependencies. As such, installing it is generally
+straightforward. There are a few methods available:
+
+### Install manually
+#### Unix-like
+On Unix-like systems, you may simply paste the following snippet into your terminal:
+
+```sh
+cd /tmp \
+  && wget https://github.com/cheat/cheat/releases/download/4.4.2/cheat-linux-amd64.gz \
+  && gunzip cheat-linux-amd64.gz \
+  && chmod +x cheat-linux-amd64 \
+  && sudo mv cheat-linux-amd64 /usr/local/bin/cheat
+```
+
+You may need to need to change the version number (`4.4.2`) and the archive
+(`cheat-linux-amd64.gz`) depending on your platform.
+
+See the [releases page][releases] for a list of supported platforms.
+
+#### Windows
+TODO: community support is requested here. Please open a PR if you'd like to
+contribute installation instructions for Windows.
+
+### Install via `go install`
+If you have `go` version `>=1.17` available on your `PATH`, you can install
+`cheat` via `go install`:
+
+```sh
+go install github.com/cheat/cheat/cmd/cheat@latest
+```
+
+### Install via package manager
+Several community-maintained packages are also available:
+
+Package manager  | Package(s)
+---------------- | -----------
+aur              | [cheat][pkg-aur-cheat], [cheat-bin][pkg-aur-cheat-bin]
+brew             | [cheat][pkg-brew]
+docker           | [docker-cheat][pkg-docker]
+nix              | [nixos.cheat][pkg-nix]
+snap             | [cheat][pkg-snap]
+
+<!--[pacman][]       |-->
+
+## Configuring
+Three things must be done before you can use `cheat`:
+1. A config file must be generated
+2. [`cheatpaths`][cheatpaths] must be configured
+3. [Community cheatsheets][community] must be downloaded
+
+On first run, `cheat` will run an installer that will do all of the above
+automatically. After the installer is complete, it is strongly advised that you
+view the configuration file that was generated, as you may want to change some
+of its default values (to enable colorization, change the paginator, etc).
+
+### conf.yml ###
+`cheat` is configured by a YAML file that will be auto-generated on first run.
+
+By default, the config file is assumed to exist on an XDG-compliant
+configuration path like `~/.config/cheat/conf.yml`. If you would like to store
+it elsewhere, you may export a `CHEAT_CONFIG_PATH` environment variable that
+specifies its path:
+
+```sh
+export CHEAT_CONFIG_PATH="~/.dotfiles/cheat/conf.yml"
+```
+
+[cheatpaths]:        README.md#cheatpaths
+[community]:         https://github.com/cheat/cheatsheets/
+[pkg-aur-cheat-bin]: https://aur.archlinux.org/packages/cheat-bin
+[pkg-aur-cheat]:     https://aur.archlinux.org/packages/cheat
+[pkg-brew]:          https://formulae.brew.sh/formula/cheat 
+[pkg-docker]:        https://github.com/bannmann/docker-cheat
+[pkg-nix]:           https://search.nixos.org/packages?channel=unstable&show=cheat&from=0&size=50&sort=relevance&type=packages&query=cheat 
+[pkg-snap]:          https://snapcraft.io/cheat
+[releases]:          https://github.com/cheat/cheat/releases

LICENSE

@@ -1,678 +0,0 @@
-
-                    GNU GENERAL PUBLIC LICENSE
-                       Version 3, 29 June 2007
-
- Copyright (C) 2007 Free Software Foundation, Inc. [http://fsf.org/]
- Everyone is permitted to copy and distribute verbatim copies
- of this license document, but changing it is not allowed.
-
-                            Preamble
-
-  The GNU General Public License is a free, copyleft license for
-software and other kinds of works.
-
-  The licenses for most software and other practical works are designed
-to take away your freedom to share and change the works.  By contrast,
-the GNU General Public License is intended to guarantee your freedom to
-share and change all versions of a program--to make sure it remains free
-software for all its users.  We, the Free Software Foundation, use the
-GNU General Public License for most of our software; it applies also to
-any other work released this way by its authors.  You can apply it to
-your programs, too.
-
-  When we speak of free software, we are referring to freedom, not
-price.  Our General Public Licenses are designed to make sure that you
-have the freedom to distribute copies of free software (and charge for
-them if you wish), that you receive source code or can get it if you
-want it, that you can change the software or use pieces of it in new
-free programs, and that you know you can do these things.
-
-  To protect your rights, we need to prevent others from denying you
-these rights or asking you to surrender the rights.  Therefore, you have
-certain responsibilities if you distribute copies of the software, or if
-you modify it: responsibilities to respect the freedom of others.
-
-  For example, if you distribute copies of such a program, whether
-gratis or for a fee, you must pass on to the recipients the same
-freedoms that you received.  You must make sure that they, too, receive
-or can get the source code.  And you must show them these terms so they
-know their rights.
-
-  Developers that use the GNU GPL protect your rights with two steps:
-(1) assert copyright on the software, and (2) offer you this License
-giving you legal permission to copy, distribute and/or modify it.
-
-  For the developers' and authors' protection, the GPL clearly explains
-that there is no warranty for this free software.  For both users' and
-authors' sake, the GPL requires that modified versions be marked as
-changed, so that their problems will not be attributed erroneously to
-authors of previous versions.
-
-  Some devices are designed to deny users access to install or run
-modified versions of the software inside them, although the manufacturer
-can do so.  This is fundamentally incompatible with the aim of
-protecting users' freedom to change the software.  The systematic
-pattern of such abuse occurs in the area of products for individuals to
-use, which is precisely where it is most unacceptable.  Therefore, we
-have designed this version of the GPL to prohibit the practice for those
-products.  If such problems arise substantially in other domains, we
-stand ready to extend this provision to those domains in future versions
-of the GPL, as needed to protect the freedom of users.
-
-  Finally, every program is threatened constantly by software patents.
-States should not allow patents to restrict development and use of
-software on general-purpose computers, but in those that do, we wish to
-avoid the special danger that patents applied to a free program could
-make it effectively proprietary.  To prevent this, the GPL assures that
-patents cannot be used to render the program non-free.
-
-  The precise terms and conditions for copying, distribution and
-modification follow.
-
-                       TERMS AND CONDITIONS
-
-  0. Definitions.
-
-  "This License" refers to version 3 of the GNU General Public License.
-
-  "Copyright" also means copyright-like laws that apply to other kinds of
-works, such as semiconductor masks.
-
-  "The Program" refers to any copyrightable work licensed under this
-License.  Each licensee is addressed as "you".  "Licensees" and
-"recipients" may be individuals or organizations.
-
-  To "modify" a work means to copy from or adapt all or part of the work
-in a fashion requiring copyright permission, other than the making of an
-exact copy.  The resulting work is called a "modified version" of the
-earlier work or a work "based on" the earlier work.
-
-  A "covered work" means either the unmodified Program or a work based
-on the Program.
-
-  To "propagate" a work means to do anything with it that, without
-permission, would make you directly or secondarily liable for
-infringement under applicable copyright law, except executing it on a
-computer or modifying a private copy.  Propagation includes copying,
-distribution (with or without modification), making available to the
-public, and in some countries other activities as well.
-
-  To "convey" a work means any kind of propagation that enables other
-parties to make or receive copies.  Mere interaction with a user through
-a computer network, with no transfer of a copy, is not conveying.
-
-  An interactive user interface displays "Appropriate Legal Notices"
-to the extent that it includes a convenient and prominently visible
-feature that (1) displays an appropriate copyright notice, and (2)
-tells the user that there is no warranty for the work (except to the
-extent that warranties are provided), that licensees may convey the
-work under this License, and how to view a copy of this License.  If
-the interface presents a list of user commands or options, such as a
-menu, a prominent item in the list meets this criterion.
-
-  1. Source Code.
-
-  The "source code" for a work means the preferred form of the work
-for making modifications to it.  "Object code" means any non-source
-form of a work.
-
-  A "Standard Interface" means an interface that either is an official
-standard defined by a recognized standards body, or, in the case of
-interfaces specified for a particular programming language, one that
-is widely used among developers working in that language.
-
-  The "System Libraries" of an executable work include anything, other
-than the work as a whole, that (a) is included in the normal form of
-packaging a Major Component, but which is not part of that Major
-Component, and (b) serves only to enable use of the work with that
-Major Component, or to implement a Standard Interface for which an
-implementation is available to the public in source code form.  A
-"Major Component", in this context, means a major essential component
-(kernel, window system, and so on) of the specific operating system
-(if any) on which the executable work runs, or a compiler used to
-produce the work, or an object code interpreter used to run it.
-
-  The "Corresponding Source" for a work in object code form means all
-the source code needed to generate, install, and (for an executable
-work) run the object code and to modify the work, including scripts to
-control those activities.  However, it does not include the work's
-System Libraries, or general-purpose tools or generally available free
-programs which are used unmodified in performing those activities but
-which are not part of the work.  For example, Corresponding Source
-includes interface definition files associated with source files for
-the work, and the source code for shared libraries and dynamically
-linked subprograms that the work is specifically designed to require,
-such as by intimate data communication or control flow between those
-subprograms and other parts of the work.
-
-  The Corresponding Source need not include anything that users
-can regenerate automatically from other parts of the Corresponding
-Source.
-
-  The Corresponding Source for a work in source code form is that
-same work.
-
-  2. Basic Permissions.
-
-  All rights granted under this License are granted for the term of
-copyright on the Program, and are irrevocable provided the stated
-conditions are met.  This License explicitly affirms your unlimited
-permission to run the unmodified Program.  The output from running a
-covered work is covered by this License only if the output, given its
-content, constitutes a covered work.  This License acknowledges your
-rights of fair use or other equivalent, as provided by copyright law.
-
-  You may make, run and propagate covered works that you do not
-convey, without conditions so long as your license otherwise remains
-in force.  You may convey covered works to others for the sole purpose
-of having them make modifications exclusively for you, or provide you
-with facilities for running those works, provided that you comply with
-the terms of this License in conveying all material for which you do
-not control copyright.  Those thus making or running the covered works
-for you must do so exclusively on your behalf, under your direction
-and control, on terms that prohibit them from making any copies of
-your copyrighted material outside their relationship with you.
-
-  Conveying under any other circumstances is permitted solely under
-the conditions stated below.  Sublicensing is not allowed; section 10
-makes it unnecessary.
-
-  3. Protecting Users' Legal Rights From Anti-Circumvention Law.
-
-  No covered work shall be deemed part of an effective technological
-measure under any applicable law fulfilling obligations under article
-11 of the WIPO copyright treaty adopted on 20 December 1996, or
-similar laws prohibiting or restricting circumvention of such
-measures.
-
-  When you convey a covered work, you waive any legal power to forbid
-circumvention of technological measures to the extent such circumvention
-is effected by exercising rights under this License with respect to
-the covered work, and you disclaim any intention to limit operation or
-modification of the work as a means of enforcing, against the work's
-users, your or third parties' legal rights to forbid circumvention of
-technological measures.
-
-  4. Conveying Verbatim Copies.
-
-  You may convey verbatim copies of the Program's source code as you
-receive it, in any medium, provided that you conspicuously and
-appropriately publish on each copy an appropriate copyright notice;
-keep intact all notices stating that this License and any
-non-permissive terms added in accord with section 7 apply to the code;
-keep intact all notices of the absence of any warranty; and give all
-recipients a copy of this License along with the Program.
-
-  You may charge any price or no price for each copy that you convey,
-and you may offer support or warranty protection for a fee.
-
-  5. Conveying Modified Source Versions.
-
-  You may convey a work based on the Program, or the modifications to
-produce it from the Program, in the form of source code under the
-terms of section 4, provided that you also meet all of these conditions:
-
-    a) The work must carry prominent notices stating that you modified
-    it, and giving a relevant date.
-
-    b) The work must carry prominent notices stating that it is
-    released under this License and any conditions added under section
-    7.  This requirement modifies the requirement in section 4 to
-    "keep intact all notices".
-
-    c) You must license the entire work, as a whole, under this
-    License to anyone who comes into possession of a copy.  This
-    License will therefore apply, along with any applicable section 7
-    additional terms, to the whole of the work, and all its parts,
-    regardless of how they are packaged.  This License gives no
-    permission to license the work in any other way, but it does not
-    invalidate such permission if you have separately received it.
-
-    d) If the work has interactive user interfaces, each must display
-    Appropriate Legal Notices; however, if the Program has interactive
-    interfaces that do not display Appropriate Legal Notices, your
-    work need not make them do so.
-
-  A compilation of a covered work with other separate and independent
-works, which are not by their nature extensions of the covered work,
-and which are not combined with it such as to form a larger program,
-in or on a volume of a storage or distribution medium, is called an
-"aggregate" if the compilation and its resulting copyright are not
-used to limit the access or legal rights of the compilation's users
-beyond what the individual works permit.  Inclusion of a covered work
-in an aggregate does not cause this License to apply to the other
-parts of the aggregate.
-
-  6. Conveying Non-Source Forms.
-
-  You may convey a covered work in object code form under the terms
-of sections 4 and 5, provided that you also convey the
-machine-readable Corresponding Source under the terms of this License,
-in one of these ways:
-
-    a) Convey the object code in, or embodied in, a physical product
-    (including a physical distribution medium), accompanied by the
-    Corresponding Source fixed on a durable physical medium
-    customarily used for software interchange.
-
-    b) Convey the object code in, or embodied in, a physical product
-    (including a physical distribution medium), accompanied by a
-    written offer, valid for at least three years and valid for as
-    long as you offer spare parts or customer support for that product
-    model, to give anyone who possesses the object code either (1) a
-    copy of the Corresponding Source for all the software in the
-    product that is covered by this License, on a durable physical
-    medium customarily used for software interchange, for a price no
-    more than your reasonable cost of physically performing this
-    conveying of source, or (2) access to copy the
-    Corresponding Source from a network server at no charge.
-
-    c) Convey individual copies of the object code with a copy of the
-    written offer to provide the Corresponding Source.  This
-    alternative is allowed only occasionally and noncommercially, and
-    only if you received the object code with such an offer, in accord
-    with subsection 6b.
-
-    d) Convey the object code by offering access from a designated
-    place (gratis or for a charge), and offer equivalent access to the
-    Corresponding Source in the same way through the same place at no
-    further charge.  You need not require recipients to copy the
-    Corresponding Source along with the object code.  If the place to
-    copy the object code is a network server, the Corresponding Source
-    may be on a different server (operated by you or a third party)
-    that supports equivalent copying facilities, provided you maintain
-    clear directions next to the object code saying where to find the
-    Corresponding Source.  Regardless of what server hosts the
-    Corresponding Source, you remain obligated to ensure that it is
-    available for as long as needed to satisfy these requirements.
-
-    e) Convey the object code using peer-to-peer transmission, provided
-    you inform other peers where the object code and Corresponding
-    Source of the work are being offered to the general public at no
-    charge under subsection 6d.
-
-  A separable portion of the object code, whose source code is excluded
-from the Corresponding Source as a System Library, need not be
-included in conveying the object code work.
-
-  A "User Product" is either (1) a "consumer product", which means any
-tangible personal property which is normally used for personal, family,
-or household purposes, or (2) anything designed or sold for incorporation
-into a dwelling.  In determining whether a product is a consumer product,
-doubtful cases shall be resolved in favor of coverage.  For a particular
-product received by a particular user, "normally used" refers to a
-typical or common use of that class of product, regardless of the status
-of the particular user or of the way in which the particular user
-actually uses, or expects or is expected to use, the product.  A product
-is a consumer product regardless of whether the product has substantial
-commercial, industrial or non-consumer uses, unless such uses represent
-the only significant mode of use of the product.
-
-  "Installation Information" for a User Product means any methods,
-procedures, authorization keys, or other information required to install
-and execute modified versions of a covered work in that User Product from
-a modified version of its Corresponding Source.  The information must
-suffice to ensure that the continued functioning of the modified object
-code is in no case prevented or interfered with solely because
-modification has been made.
-
-  If you convey an object code work under this section in, or with, or
-specifically for use in, a User Product, and the conveying occurs as
-part of a transaction in which the right of possession and use of the
-User Product is transferred to the recipient in perpetuity or for a
-fixed term (regardless of how the transaction is characterized), the
-Corresponding Source conveyed under this section must be accompanied
-by the Installation Information.  But this requirement does not apply
-if neither you nor any third party retains the ability to install
-modified object code on the User Product (for example, the work has
-been installed in ROM).
-
-  The requirement to provide Installation Information does not include a
-requirement to continue to provide support service, warranty, or updates
-for a work that has been modified or installed by the recipient, or for
-the User Product in which it has been modified or installed.  Access to a
-network may be denied when the modification itself materially and
-adversely affects the operation of the network or violates the rules and
-protocols for communication across the network.
-
-  Corresponding Source conveyed, and Installation Information provided,
-in accord with this section must be in a format that is publicly
-documented (and with an implementation available to the public in
-source code form), and must require no special password or key for
-unpacking, reading or copying.
-
-  7. Additional Terms.
-
-  "Additional permissions" are terms that supplement the terms of this
-License by making exceptions from one or more of its conditions.
-Additional permissions that are applicable to the entire Program shall
-be treated as though they were included in this License, to the extent
-that they are valid under applicable law.  If additional permissions
-apply only to part of the Program, that part may be used separately
-under those permissions, but the entire Program remains governed by
-this License without regard to the additional permissions.
-
-  When you convey a copy of a covered work, you may at your option
-remove any additional permissions from that copy, or from any part of
-it.  (Additional permissions may be written to require their own
-removal in certain cases when you modify the work.)  You may place
-additional permissions on material, added by you to a covered work,
-for which you have or can give appropriate copyright permission.
-
-  Notwithstanding any other provision of this License, for material you
-add to a covered work, you may (if authorized by the copyright holders of
-that material) supplement the terms of this License with terms:
-
-    a) Disclaiming warranty or limiting liability differently from the
-    terms of sections 15 and 16 of this License; or
-
-    b) Requiring preservation of specified reasonable legal notices or
-    author attributions in that material or in the Appropriate Legal
-    Notices displayed by works containing it; or
-
-    c) Prohibiting misrepresentation of the origin of that material, or
-    requiring that modified versions of such material be marked in
-    reasonable ways as different from the original version; or
-
-    d) Limiting the use for publicity purposes of names of licensors or
-    authors of the material; or
-
-    e) Declining to grant rights under trademark law for use of some
-    trade names, trademarks, or service marks; or
-
-    f) Requiring indemnification of licensors and authors of that
-    material by anyone who conveys the material (or modified versions of
-    it) with contractual assumptions of liability to the recipient, for
-    any liability that these contractual assumptions directly impose on
-    those licensors and authors.
-
-  All other non-permissive additional terms are considered "further
-restrictions" within the meaning of section 10.  If the Program as you
-received it, or any part of it, contains a notice stating that it is
-governed by this License along with a term that is a further
-restriction, you may remove that term.  If a license document contains
-a further restriction but permits relicensing or conveying under this
-License, you may add to a covered work material governed by the terms
-of that license document, provided that the further restriction does
-not survive such relicensing or conveying.
-
-  If you add terms to a covered work in accord with this section, you
-must place, in the relevant source files, a statement of the
-additional terms that apply to those files, or a notice indicating
-where to find the applicable terms.
-
-  Additional terms, permissive or non-permissive, may be stated in the
-form of a separately written license, or stated as exceptions;
-the above requirements apply either way.
-
-  8. Termination.
-
-  You may not propagate or modify a covered work except as expressly
-provided under this License.  Any attempt otherwise to propagate or
-modify it is void, and will automatically terminate your rights under
-this License (including any patent licenses granted under the third
-paragraph of section 11).
-
-  However, if you cease all violation of this License, then your
-license from a particular copyright holder is reinstated (a)
-provisionally, unless and until the copyright holder explicitly and
-finally terminates your license, and (b) permanently, if the copyright
-holder fails to notify you of the violation by some reasonable means
-prior to 60 days after the cessation.
-
-  Moreover, your license from a particular copyright holder is
-reinstated permanently if the copyright holder notifies you of the
-violation by some reasonable means, this is the first time you have
-received notice of violation of this License (for any work) from that
-copyright holder, and you cure the violation prior to 30 days after
-your receipt of the notice.
-
-  Termination of your rights under this section does not terminate the
-licenses of parties who have received copies or rights from you under
-this License.  If your rights have been terminated and not permanently
-reinstated, you do not qualify to receive new licenses for the same
-material under section 10.
-
-  9. Acceptance Not Required for Having Copies.
-
-  You are not required to accept this License in order to receive or
-run a copy of the Program.  Ancillary propagation of a covered work
-occurring solely as a consequence of using peer-to-peer transmission
-to receive a copy likewise does not require acceptance.  However,
-nothing other than this License grants you permission to propagate or
-modify any covered work.  These actions infringe copyright if you do
-not accept this License.  Therefore, by modifying or propagating a
-covered work, you indicate your acceptance of this License to do so.
-
-  10. Automatic Licensing of Downstream Recipients.
-
-  Each time you convey a covered work, the recipient automatically
-receives a license from the original licensors, to run, modify and
-propagate that work, subject to this License.  You are not responsible
-for enforcing compliance by third parties with this License.
-
-  An "entity transaction" is a transaction transferring control of an
-organization, or substantially all assets of one, or subdividing an
-organization, or merging organizations.  If propagation of a covered
-work results from an entity transaction, each party to that
-transaction who receives a copy of the work also receives whatever
-licenses to the work the party's predecessor in interest had or could
-give under the previous paragraph, plus a right to possession of the
-Corresponding Source of the work from the predecessor in interest, if
-the predecessor has it or can get it with reasonable efforts.
-
-  You may not impose any further restrictions on the exercise of the
-rights granted or affirmed under this License.  For example, you may
-not impose a license fee, royalty, or other charge for exercise of
-rights granted under this License, and you may not initiate litigation
-(including a cross-claim or counterclaim in a lawsuit) alleging that
-any patent claim is infringed by making, using, selling, offering for
-sale, or importing the Program or any portion of it.
-
-  11. Patents.
-
-  A "contributor" is a copyright holder who authorizes use under this
-License of the Program or a work on which the Program is based.  The
-work thus licensed is called the contributor's "contributor version".
-
-  A contributor's "essential patent claims" are all patent claims
-owned or controlled by the contributor, whether already acquired or
-hereafter acquired, that would be infringed by some manner, permitted
-by this License, of making, using, or selling its contributor version,
-but do not include claims that would be infringed only as a
-consequence of further modification of the contributor version.  For
-purposes of this definition, "control" includes the right to grant
-patent sublicenses in a manner consistent with the requirements of
-this License.
-
-  Each contributor grants you a non-exclusive, worldwide, royalty-free
-patent license under the contributor's essential patent claims, to
-make, use, sell, offer for sale, import and otherwise run, modify and
-propagate the contents of its contributor version.
-
-  In the following three paragraphs, a "patent license" is any express
-agreement or commitment, however denominated, not to enforce a patent
-(such as an express permission to practice a patent or covenant not to
-sue for patent infringement).  To "grant" such a patent license to a
-party means to make such an agreement or commitment not to enforce a
-patent against the party.
-
-  If you convey a covered work, knowingly relying on a patent license,
-and the Corresponding Source of the work is not available for anyone
-to copy, free of charge and under the terms of this License, through a
-publicly available network server or other readily accessible means,
-then you must either (1) cause the Corresponding Source to be so
-available, or (2) arrange to deprive yourself of the benefit of the
-patent license for this particular work, or (3) arrange, in a manner
-consistent with the requirements of this License, to extend the patent
-license to downstream recipients.  "Knowingly relying" means you have
-actual knowledge that, but for the patent license, your conveying the
-covered work in a country, or your recipient's use of the covered work
-in a country, would infringe one or more identifiable patents in that
-country that you have reason to believe are valid.
-
-  If, pursuant to or in connection with a single transaction or
-arrangement, you convey, or propagate by procuring conveyance of, a
-covered work, and grant a patent license to some of the parties
-receiving the covered work authorizing them to use, propagate, modify
-or convey a specific copy of the covered work, then the patent license
-you grant is automatically extended to all recipients of the covered
-work and works based on it.
-
-  A patent license is "discriminatory" if it does not include within
-the scope of its coverage, prohibits the exercise of, or is
-conditioned on the non-exercise of one or more of the rights that are
-specifically granted under this License.  You may not convey a covered
-work if you are a party to an arrangement with a third party that is
-in the business of distributing software, under which you make payment
-to the third party based on the extent of your activity of conveying
-the work, and under which the third party grants, to any of the
-parties who would receive the covered work from you, a discriminatory
-patent license (a) in connection with copies of the covered work
-conveyed by you (or copies made from those copies), or (b) primarily
-for and in connection with specific products or compilations that
-contain the covered work, unless you entered into that arrangement,
-or that patent license was granted, prior to 28 March 2007.
-
-  Nothing in this License shall be construed as excluding or limiting
-any implied license or other defenses to infringement that may
-otherwise be available to you under applicable patent law.
-
-  12. No Surrender of Others' Freedom.
-
-  If conditions are imposed on you (whether by court order, agreement or
-otherwise) that contradict the conditions of this License, they do not
-excuse you from the conditions of this License.  If you cannot convey a
-covered work so as to satisfy simultaneously your obligations under this
-License and any other pertinent obligations, then as a consequence you may
-not convey it at all.  For example, if you agree to terms that obligate you
-to collect a royalty for further conveying from those to whom you convey
-the Program, the only way you could satisfy both those terms and this
-License would be to refrain entirely from conveying the Program.
-
-  13. Use with the GNU Affero General Public License.
-
-  Notwithstanding any other provision of this License, you have
-permission to link or combine any covered work with a work licensed
-under version 3 of the GNU Affero General Public License into a single
-combined work, and to convey the resulting work.  The terms of this
-License will continue to apply to the part which is the covered work,
-but the special requirements of the GNU Affero General Public License,
-section 13, concerning interaction through a network will apply to the
-combination as such.
-
-  14. Revised Versions of this License.
-
-  The Free Software Foundation may publish revised and/or new versions of
-the GNU General Public License from time to time.  Such new versions will
-be similar in spirit to the present version, but may differ in detail to
-address new problems or concerns.
-
-  Each version is given a distinguishing version number.  If the
-Program specifies that a certain numbered version of the GNU General
-Public License "or any later version" applies to it, you have the
-option of following the terms and conditions either of that numbered
-version or of any later version published by the Free Software
-Foundation.  If the Program does not specify a version number of the
-GNU General Public License, you may choose any version ever published
-by the Free Software Foundation.
-
-  If the Program specifies that a proxy can decide which future
-versions of the GNU General Public License can be used, that proxy's
-public statement of acceptance of a version permanently authorizes you
-to choose that version for the Program.
-
-  Later license versions may give you additional or different
-permissions.  However, no additional obligations are imposed on any
-author or copyright holder as a result of your choosing to follow a
-later version.
-
-  15. Disclaimer of Warranty.
-
-  THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
-APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
-HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
-OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
-THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
-PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
-IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
-ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
-
-  16. Limitation of Liability.
-
-  IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
-WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
-THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
-GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
-USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
-DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
-PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
-EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
-SUCH DAMAGES.
-
-  17. Interpretation of Sections 15 and 16.
-
-  If the disclaimer of warranty and limitation of liability provided
-above cannot be given local legal effect according to their terms,
-reviewing courts shall apply local law that most closely approximates
-an absolute waiver of all civil liability in connection with the
-Program, unless a warranty or assumption of liability accompanies a
-copy of the Program in return for a fee.
-
-                     END OF TERMS AND CONDITIONS
-
-            How to Apply These Terms to Your New Programs
-
-  If you develop a new program, and you want it to be of the greatest
-possible use to the public, the best way to achieve this is to make it
-free software which everyone can redistribute and change under these terms.
-
-  To do so, attach the following notices to the program.  It is safest
-to attach them to the start of each source file to most effectively
-state the exclusion of warranty; and each file should have at least
-the "copyright" line and a pointer to where the full notice is found.
-
-    {one line to give the program's name and a brief idea of what it does.}
-    Copyright (C) {year}  {name of author}
-
-    This program is free software: you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation, either version 3 of the License, or
-    (at your option) any later version.
-
-    This program is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
-
-    You should have received a copy of the GNU General Public License
-    along with this program.  If not, see [http://www.gnu.org/licenses/].
-
-Also add information on how to contact you by electronic and paper mail.
-
-  If the program does terminal interaction, make it output a short
-notice like this when it starts in an interactive mode:
-
-    {project}  Copyright (C) {year}  {fullname}
-    This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
-    This is free software, and you are welcome to redistribute it
-    under certain conditions; type `show c' for details.
-
-The hypothetical commands `show w' and `show c' should show the appropriate
-parts of the General Public License.  Of course, your program's commands
-might be different; for a GUI interface, you would use an "about box".
-
-  You should also get your employer (if you work as a programmer) or school,
-if any, to sign a "copyright disclaimer" for the program, if necessary.
-For more information on this, and how to apply and follow the GNU GPL, see
-[http://www.gnu.org/licenses/].
-
-  The GNU General Public License does not permit incorporating your program
-into proprietary programs.  If your program is a subroutine library, you
-may consider it more useful to permit linking proprietary applications with
-the library.  If this is what you want to do, use the GNU Lesser General
-Public License instead of this License.  But first, please read
-[http://www.gnu.org/philosophy/why-not-lgpl.html].
-
-        
-          

LICENSE.txt

@@ -0,0 +1,19 @@
+Copyright 2013 Christopher Allen Lane
+
+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.

Makefile

@@ -0,0 +1,218 @@
+# paths
+makefile := $(realpath $(lastword $(MAKEFILE_LIST)))
+cmd_dir  := ./cmd/cheat
+dist_dir := ./dist
+
+# executables
+CAT    := cat
+COLUMN := column
+CTAGS  := ctags
+DOCKER := docker
+GO     := go
+GREP   := grep
+GZIP   := gzip --best
+LINT   := revive
+MAN    := man
+MKDIR  := mkdir -p
+PANDOC := pandoc
+RM     := rm
+SCC    := scc
+SED    := sed
+SORT   := sort
+ZIP    := zip -m
+
+docker_image := cheat-devel:latest
+
+# build flags
+BUILD_FLAGS  := -ldflags="-s -w" -mod vendor -trimpath
+GOBIN        :=
+TMPDIR       := /tmp
+
+# release binaries
+releases :=                        \
+	$(dist_dir)/cheat-darwin-amd64 \
+	$(dist_dir)/cheat-linux-386    \
+	$(dist_dir)/cheat-linux-amd64  \
+	$(dist_dir)/cheat-linux-arm5   \
+	$(dist_dir)/cheat-linux-arm6   \
+	$(dist_dir)/cheat-linux-arm64  \
+	$(dist_dir)/cheat-linux-arm7   \
+	$(dist_dir)/cheat-netbsd-amd64  \
+	$(dist_dir)/cheat-openbsd-amd64  \
+	$(dist_dir)/cheat-solaris-amd64  \
+	$(dist_dir)/cheat-windows-amd64.exe
+
+## build: build an executable for your architecture
+.PHONY: build
+build: | clean $(dist_dir) generate fmt lint vet vendor man
+	$(GO) build $(BUILD_FLAGS) -o $(dist_dir)/cheat $(cmd_dir)
+
+## build-release: build release executables
+.PHONY: build-release
+build-release: $(releases)
+
+# cheat-darwin-amd64
+$(dist_dir)/cheat-darwin-amd64: prepare
+	GOARCH=amd64 GOOS=darwin \
+	$(GO) build $(BUILD_FLAGS) -o $@ $(cmd_dir) && $(GZIP) $@ && chmod -x $@.gz
+
+# cheat-linux-386
+$(dist_dir)/cheat-linux-386: prepare
+	GOARCH=386 GOOS=linux \
+	$(GO) build $(BUILD_FLAGS) -o $@ $(cmd_dir) && $(GZIP) $@ && chmod -x $@.gz
+
+# cheat-linux-amd64
+$(dist_dir)/cheat-linux-amd64: prepare
+	GOARCH=amd64 GOOS=linux \
+	$(GO) build $(BUILD_FLAGS) -o $@ $(cmd_dir) && $(GZIP) $@ && chmod -x $@.gz
+
+# cheat-linux-arm5
+$(dist_dir)/cheat-linux-arm5: prepare
+	GOARCH=arm GOOS=linux GOARM=5 \
+	$(GO) build $(BUILD_FLAGS) -o $@ $(cmd_dir) && $(GZIP) $@ && chmod -x $@.gz
+
+# cheat-linux-arm6
+$(dist_dir)/cheat-linux-arm6: prepare
+	GOARCH=arm GOOS=linux GOARM=6 \
+	$(GO) build $(BUILD_FLAGS) -o $@ $(cmd_dir) && $(GZIP) $@ && chmod -x $@.gz
+
+# cheat-linux-arm7
+$(dist_dir)/cheat-linux-arm7: prepare
+	GOARCH=arm GOOS=linux GOARM=7 \
+	$(GO) build $(BUILD_FLAGS) -o $@ $(cmd_dir) && $(GZIP) $@ && chmod -x $@.gz
+	
+# cheat-linux-arm64
+$(dist_dir)/cheat-linux-arm64: prepare
+	GOARCH=arm64 GOOS=linux \
+	$(GO) build $(BUILD_FLAGS) -o $@ $(cmd_dir) && $(GZIP) $@ && chmod -x $@.gz
+
+# cheat-netbsd-amd64
+$(dist_dir)/cheat-netbsd-amd64: prepare
+	GOARCH=amd64 GOOS=netbsd \
+	$(GO) build $(BUILD_FLAGS) -o $@ $(cmd_dir) && $(GZIP) $@ && chmod -x $@.gz
+
+# cheat-openbsd-amd64
+$(dist_dir)/cheat-openbsd-amd64: prepare
+	GOARCH=amd64 GOOS=openbsd \
+	$(GO) build $(BUILD_FLAGS) -o $@ $(cmd_dir) && $(GZIP) $@ && chmod -x $@.gz
+
+# cheat-plan9-amd64
+$(dist_dir)/cheat-plan9-amd64: prepare
+	GOARCH=amd64 GOOS=plan9 \
+	$(GO) build $(BUILD_FLAGS) -o $@ $(cmd_dir) && $(GZIP) $@ && chmod -x $@.gz
+
+# cheat-solaris-amd64
+$(dist_dir)/cheat-solaris-amd64: prepare
+	GOARCH=amd64 GOOS=solaris \
+	$(GO) build $(BUILD_FLAGS) -o $@ $(cmd_dir) && $(GZIP) $@ && chmod -x $@.gz
+
+# cheat-windows-amd64
+$(dist_dir)/cheat-windows-amd64.exe: prepare
+	GOARCH=amd64 GOOS=windows \
+	$(GO) build $(BUILD_FLAGS) -o $@ $(cmd_dir) && $(ZIP) $@.zip $@ -j
+
+# ./dist
+$(dist_dir):
+	$(MKDIR) $(dist_dir)
+
+.PHONY: generate
+generate:
+	$(GO) generate $(cmd_dir)
+
+## install: build and install cheat on your PATH
+.PHONY: install
+install: build
+	$(GO) install $(BUILD_FLAGS) $(GOBIN) $(cmd_dir) 
+
+## clean: remove compiled executables
+.PHONY: clean
+clean:
+	$(RM) -f $(dist_dir)/* $(cmd_dir)/str_config.go $(cmd_dir)/str_usage.go
+
+## distclean: remove the tags file
+.PHONY: distclean
+distclean:
+	$(RM) -f tags
+	@$(DOCKER) image rm -f $(docker_image)
+
+## setup: install revive (linter) and scc (sloc tool)
+.PHONY: setup
+setup:
+	GO111MODULE=off $(GO) get -u github.com/boyter/scc github.com/mgechev/revive
+
+## sloc: count "semantic lines of code"
+.PHONY: sloc
+sloc:
+	$(SCC) --exclude-dir=vendor
+
+## tags: build a tags file
+.PHONY: tags
+tags:
+	$(CTAGS) -R --exclude=vendor --languages=go
+
+## man: build a man page
+# NB: pandoc may not be installed, so we're ignoring this error on failure
+.PHONY: man
+man:
+	-$(PANDOC) -s -t man doc/cheat.1.md -o doc/cheat.1
+
+## vendor: download, tidy, and verify dependencies
+.PHONY: vendor
+vendor:
+	$(GO) mod vendor && $(GO) mod tidy && $(GO) mod verify
+
+## vendor-update: update vendored dependencies
+vendor-update:
+	$(GO) get -t -u ./... && $(GO) mod vendor && $(GO) mod tidy && $(GO) mod verify
+
+## fmt: run go fmt
+.PHONY: fmt
+fmt:
+	$(GO) fmt ./...
+
+## lint: lint go source files
+.PHONY: lint
+lint: vendor
+	$(LINT) -exclude vendor/... ./...
+
+## vet: vet go source files
+.PHONY: vet
+vet:
+	$(GO) vet ./...
+
+## test: run unit-tests
+.PHONY: test
+test: 
+	$(GO) test ./...
+
+## coverage: generate a test coverage report
+.PHONY: coverage
+coverage:
+	$(GO) test ./... -coverprofile=$(TMPDIR)/cheat-coverage.out && \
+	$(GO) tool cover -html=$(TMPDIR)/cheat-coverage.out
+
+## check: format, lint, vet, vendor, and run unit-tests
+.PHONY: check
+check: | vendor fmt lint vet test
+
+.PHONY: prepare
+prepare: | clean $(dist_dir) generate vendor fmt lint vet test
+
+## docker-setup: create a docker image for use during development
+.PHONY: docker-setup
+docker-setup:
+	$(DOCKER) build  -t $(docker_image) -f Dockerfile .
+
+## docker-sh: shell into the docker development container
+.PHONY: docker-sh
+docker-sh:
+	$(DOCKER) run -v $(shell pwd):/app -ti $(docker_image) /bin/ash
+
+## help: display this help text
+.PHONY: help
+help:
+	@$(CAT) $(makefile) | \
+	$(SORT)             | \
+	$(GREP) "^##"       | \
+	$(SED) 's/## //g'   | \
+	$(COLUMN) -t -s ':'

README.md

@@ -1,5 +1,9 @@
+![Workflow status](https://github.com/cheat/cheat/actions/workflows/build.yml/badge.svg)
+
+
 cheat
 =====
+
 `cheat` allows you to create and view interactive cheatsheets on the
 command-line. It was designed to help remind \*nix system administrators of
 options for commands that they use frequently, but not frequently enough to
@@ -7,7 +11,7 @@ remember.
 
 ![The obligatory xkcd](http://imgs.xkcd.com/comics/tar.png 'The obligatory xkcd')
 
-`cheat` depends only on `python` and `pip`.
+Use `cheat` with [cheatsheets][].
 
 
 Example
@@ -15,114 +19,175 @@ Example
 The next time you're forced to disarm a nuclear weapon without consulting
 Google, you may run:
 
-    cheat tar
-
-You will be presented with a cheatsheet resembling:
-
+```sh
+cheat tar
 ```
-# To extract an uncompressed archive: 
-tar -xvf /path/to/foo.tar
+
+You will be presented with a cheatsheet resembling the following:
+
+```sh
+# To extract an uncompressed archive:
+tar -xvf '/path/to/foo.tar'
 
 # To extract a .gz archive:
-tar -xzvf /path/to/foo.tgz
+tar -xzvf '/path/to/foo.tgz'
 
 # To create a .gz archive:
-tar -czvf /path/to/foo.tgz /path/to/foo/
+tar -czvf '/path/to/foo.tgz' '/path/to/foo/'
 
 # To extract a .bz2 archive:
-tar -xjvf /path/to/foo.tgz
+tar -xjvf '/path/to/foo.tgz'
 
 # To create a .bz2 archive:
-tar -cjvf /path/to/foo.tgz /path/to/foo/
+tar -cjvf '/path/to/foo.tgz' '/path/to/foo/'
 ```
 
-To see what cheatsheets are availble, run `cheat -l`.
+Usage
+-----
+To view a cheatsheet:
+
+```sh
+cheat tar      # a "top-level" cheatsheet
+cheat foo/bar  # a "nested" cheatsheet
+```
+
+To edit a cheatsheet:
+
+```sh
+cheat -e tar     # opens the "tar" cheatsheet for editing, or creates it if it does not exist
+cheat -e foo/bar # nested cheatsheets are accessed like this
+```
+
+To view the configured cheatpaths:
+
+```sh
+cheat -d
+```
+
+To list all available cheatsheets:
+
+```sh
+cheat -l
+```
+
+To list all cheatsheets that are tagged with "networking":
+
+```sh
+cheat -l -t networking
+```
+
+To list all cheatsheets on the "personal" path:
+
+```sh
+cheat -l -p personal
+```
+
+To search for the phrase "ssh" among cheatsheets:
+
+```sh
+cheat -s ssh
+```
+
+To search (by regex) for cheatsheets that contain an IP address:
+
+```sh
+cheat -r -s '(?:[0-9]{1,3}\.){3}[0-9]{1,3}'
+```
+
+Flags may be combined in intuitive ways. Example: to search sheets on the
+"personal" cheatpath that are tagged with "networking" and match a regex:
+
+```sh
+cheat -p personal -t networking --regex -s '(?:[0-9]{1,3}\.){3}[0-9]{1,3}'
+```
 
-Note that, while `cheat` was designed primarily for *nix system administrators,
-it is agnostic as to what content it stores. If you would like to use `cheat`
-to store notes on your favorite cookie recipes, feel free.
 
 
 Installing
 ----------
-First install the required python dependencies with:
+For installation and configuration instructions, see [INSTALLING.md][].
 
-    sudo pip install docopt pygments
-
-Then, clone this repository, `cd` into it, and run:
-
-    sudo python setup.py install
-
-
-Modifying Cheatsheets
----------------------
-The value of `cheat` is that it allows you to create your own cheatsheets - the
-defaults are meant to serve only as a starting point, and can and should be
-modified.
-
-Cheatsheets are stored in the `~/.cheat/` directory, and are named on a
-per-keyphrase basis. In other words, the content for the `tar` cheatsheet lives
-in the `~/.cheat/tar` file.
-
-Provided that you have an `EDITOR` environment variable set, you may edit
-cheatsheets with:
-
-    cheat -e foo
-
-If the 'foo' cheatsheet already exists, it will be opened for editing.
-Otherwise, it will be created automatically.
-
-After you've customized your cheatsheets, I urge you to track `~/.cheat/` along
-with your [dotfiles][].
-
-
-Configuring
+Cheatsheets
 -----------
+Cheatsheets are plain-text files with no file extension, and are named
+according to the command used to view them:
 
-### Setting a DEFAULT_CHEAT_DIR ###
-Personal cheatsheets are saved in the `~/.cheat` directory by default, but you
-can specify a different default by exporting a `DEFAULT_CHEAT_DIR` environment
-variable:
+```sh
+cheat tar     # file is named "tar"
+cheat foo/bar # file is named "bar", in a "foo" subdirectory
+```
 
-    export DEFAULT_CHEAT_DIR=/path/to/my/cheats
+Cheatsheet text may optionally be preceeded by a YAML frontmatter header that
+assigns tags and specifies syntax:
 
-### Setting a CHEATPATH ###
-You can additionally instruct `cheat` to look for cheatsheets in other
-directories by exporting a `CHEATPATH` environment variable:
+```
+---
+syntax: javascript
+tags: [ array, map ]
+---
+// To map over an array:
+const squares = [1, 2, 3, 4].map(x => x * x);
+```
 
-    export CHEATPATH=/path/to/my/cheats
+The `cheat` executable includes no cheatsheets, but [community-sourced
+cheatsheets are available][cheatsheets]. You will be asked if you would like to
+install the community-sourced cheatsheets the first time you run `cheat`.
 
-You may, of course, append multiple directories to your `CHEATPATH`:
+Cheatpaths
+----------
+Cheatsheets are stored on "cheatpaths", which are directories that contain
+cheatsheets. Cheatpaths are specified in the `conf.yml` file.
 
-    export CHEATPATH=$CHEATPATH:/path/to/more/cheats
+It can be useful to configure `cheat` against multiple cheatpaths. A common
+pattern is to store cheatsheets from multiple repositories on individual
+cheatpaths:
 
-You may view which directories are on your `CHEATPATH` with `cheat -d`.
+```yaml
+# conf.yml:
+# ...
+cheatpaths:
+  - name: community                   # a name for the cheatpath
+    path: ~/documents/cheat/community # the path's location on the filesystem
+    tags: [ community ]               # these tags will be applied to all sheets on the path
+    readonly: true                    # if true, `cheat` will not create new cheatsheets here
 
-### Enabling Syntax Highlighting ###
-`cheat` can apply syntax highlighting to your cheatsheets if so desired. To
-enable this feature, set a `CHEATCOLORS` environment variable:
+  - name: personal
+    path: ~/documents/cheat/personal  # this is a separate directory and repository than above
+    tags: [ personal ]
+    readonly: false                   # new sheets may be written here
+# ...
+```
 
-    export CHEATCOLORS=true
+The `readonly` option instructs `cheat` not to edit (or create) any cheatsheets
+on the path. This is useful to prevent merge-conflicts from arising on upstream
+cheatsheet repositories.
 
+If a user attempts to edit a cheatsheet on a read-only cheatpath, `cheat` will
+transparently copy that sheet to a writeable directory before opening it for
+editing.
 
-Related Projects
-----------------
+### Directory-scoped Cheatpaths ###
+At times, it can be useful to closely associate cheatsheets with a directory on
+your filesystem. `cheat` facilitates this by searching for a `.cheat` folder in
+the current working directory. If found, the `.cheat` directory will
+(temporarily) be added to the cheatpaths.
 
-- [lucaswerkmeister/cheats][1]: An implementation of this concept in pure bash
-  that also allows not only for numerical indexing of subcomands but also
-  supports running commands interactively.
+Autocompletion
+--------------
+Shell autocompletion is currently available for `bash`, `fish`, and `zsh`. Copy
+the relevant [completion script][completions] into the appropriate directory on
+your filesystem to enable autocompletion. (This directory will vary depending
+on operating system and shell specifics.)
 
-- [jahendrie/cheat][2]: A bash-only implementation that additionally allows for
-  cheatsheets to be created and `grep` searched from the command-line.
-  ([jahendrie][] contributed key ideas to this project as well.)
+Additionally, `cheat` supports enhanced autocompletion via integration with
+[fzf][]. To enable `fzf` integration:
 
-- [`cheat` RubyGem][3]: A clever gem from 2006 that clearly had similar
-  motivations. It is unclear whether or not it is currently maintained.
+1. Ensure that `fzf` is available on your `$PATH`
+2. Set an envvar: `export CHEAT_USE_FZF=true`
 
-
-[dotfiles]:  http://dotfiles.github.io/
-[jahendrie]: https://github.com/jahendrie
-[1]:         https://github.com/lucaswerkmeister/cheats   
-[2]:         https://github.com/jahendrie/cheat
-[3]:         http://errtheblog.com/posts/21-cheat
-[4]:         https://github.com/chrisallenlane/cheat/pull/77
+[INSTALLING.md]: INSTALLING.md
+[Releases]:      https://github.com/cheat/cheat/releases
+[cheatsheets]:   https://github.com/cheat/cheatsheets
+[completions]:   https://github.com/cheat/cheat/tree/master/scripts
+[fzf]:           https://github.com/junegunn/fzf
+[go]:            https://golang.org

bin/cheat

@@ -1,61 +0,0 @@
-#!/usr/bin/env python
-
-"""cheat
-
-Usage:
-  cheat <cheatsheet>
-  cheat -e <cheatsheet>
-  cheat -s <keyword>
-  cheat -l
-  cheat -d
-  cheat -v
-
-cheat allows you to create and view interactive cheatsheets on the
-command-line. It was designed to help remind *nix system
-administrators of options for commands that they use frequently,
-but not frequently enough to remember.
-
-Examples:
-  To look up 'tar':
-  cheat tar
-
-  To create or edit the cheatsheet for 'foo':
-  cheat -e foo
-
-Options:
-  -d --directories  List directories on CHEATPATH
-  -e --edit         Edit cheatsheet
-  -l --list         List cheatsheets
-  -s --search       Search cheatsheets for <keyword>
-  -v --version      Print the version number
-"""
-
-# require the dependencies
-from cheat import *
-from cheat.utils import *
-from docopt import docopt
-
-
-if __name__ == '__main__':
-    # parse the command-line options
-    options = docopt(__doc__, version='cheat 2.0.4')
-
-    # list directories
-    if options['--directories']:
-        print("\n".join(sheets.paths()))
-
-    # list cheatsheets
-    elif options['--list']:
-        print(sheets.list())
-
-    # create/edit cheatsheet
-    elif options['--edit']:
-        sheet.create_or_edit(options['<cheatsheet>'])
-
-    # search among the cheatsheets
-    elif options['--search']:
-        print(colorize(sheets.search(options['<keyword>'])))
-
-    # print the cheatsheet
-    else:
-        print(colorize(sheet.read(options['<cheatsheet>'])))

build/embed.go

@@ -0,0 +1,92 @@
+//go:build ignore
+// +build ignore
+
+// This script embeds `docopt.txt and `conf.yml` into the binary during at
+// build time.
+
+package main
+
+import (
+	"fmt"
+	"io/ioutil"
+	"log"
+	"os"
+	"path/filepath"
+)
+
+func main() {
+
+	// get the cwd
+	cwd, err := os.Getwd()
+	if err != nil {
+		log.Fatal(err)
+	}
+
+	// get the project root
+	root, err := filepath.Abs(cwd + "../../../")
+	if err != nil {
+		log.Fatal(err)
+	}
+
+	// specify template file information
+	type file struct {
+		In     string
+		Out    string
+		Method string
+	}
+
+	// enumerate the template files to process
+	files := []file{
+		file{
+			In:     "cmd/cheat/docopt.txt",
+			Out:    "cmd/cheat/str_usage.go",
+			Method: "usage"},
+		file{
+			In:     "configs/conf.yml",
+			Out:    "cmd/cheat/str_config.go",
+			Method: "configs"},
+	}
+
+	// iterate over each static file
+	for _, file := range files {
+
+		// delete the outfile
+		os.Remove(filepath.Join(root, file.Out))
+
+		// read the static template
+		bytes, err := ioutil.ReadFile(filepath.Join(root, file.In))
+		if err != nil {
+			log.Fatal(err)
+		}
+
+		// render the template
+		data := template(file.Method, string(bytes))
+
+		// write the file to the specified outpath
+		spath := filepath.Join(root, file.Out)
+		err = ioutil.WriteFile(spath, []byte(data), 0644)
+		if err != nil {
+			log.Fatal(err)
+		}
+	}
+}
+
+// template packages the
+func template(method string, body string) string {
+
+	// specify the template string
+	t := `package main
+
+// Code generated .* DO NOT EDIT.
+
+import (
+	"strings"
+)
+
+func %s() string {
+	return strings.TrimSpace(%s)
+}
+`
+
+	return fmt.Sprintf(t, method, "`"+body+"`")
+}

cheat/__init__.py

@@ -1,3 +0,0 @@
-import sheet
-import sheets
-import utils

cheat/autocompletion/_cheat.zsh

@@ -1,5 +0,0 @@
-#compdef cheat
-
-declare -a cheats
-cheats=$(cheat -l | cut -d' ' -f1)
-_arguments "1:cheats:(${cheats})" && return 0

cheat/autocompletion/cheat.bash

@@ -1,9 +0,0 @@
-function _cheat_autocomplete {
-    sheets=$(cheat -l | cut -d' ' -f1)
-    COMPREPLY=()
-    if [ $COMP_CWORD = 1 ]; then
-	COMPREPLY=(`compgen -W "$sheets" -- $2`)
-    fi
-}
-
-complete -F _cheat_autocomplete cheat

cheat/autocompletion/cheat.fish

@@ -1,12 +0,0 @@
-#completion for cheat
-complete -c cheat -s h -l help -f -x --description "Display help and exit"
-complete -c cheat -l edit -f -x --description "Edit <cheatsheet>"
-complete -c cheat -s e -f -x --description "Edit <cheatsheet>"
-complete -c cheat -s l -l list -f -x --description "List all available cheatsheets"
-complete -c cheat -s d -l cheat-directories -f -x --description "List all current cheat dirs"
-complete -c cheat --authoritative -f
-for cheatsheet in (cheat -l | cut -d' ' -f1)
-    complete -c cheat -a "$cheatsheet"
-    complete -c cheat -o e -a "$cheatsheet" 
-    complete -c cheat -o '-edit' -a "$cheatsheet"
-end

cheat/cheatsheets/7z

@@ -1,29 +0,0 @@
-7z
-A file archiver with highest compression ratio
-
-Args:
-a       add
-d       delete
-e       extract
-l       list
-t       test
-u       update
-x       extract with full paths
-
-Example:
-7z a -t7z -m0-lzma -mx=9 -mfb=64 -md=32m -ms=on archive.7z dir1
-
--t7z        7z archive
--m0=lzma    lzma method
--mx=9       level of compression = 9 (ultra)
--mfb=64     number of fast bytes for lzma = 64
--md=32m     dictionary size = 32 Mb
--ms=on      solid archive = on
-
-7z exit codes:
-0       normal (no errors or warnings)
-1       warning (non-fatal errors)
-2       fatal error
-7       bad cli arguments
-8       not enough memory for operation
-255     process was interrupted

cheat/cheatsheets/__init__.py

@@ -1,4 +0,0 @@
-import os
-
-def sheets_dir():
-  return os.path.split(__file__)

cheat/cheatsheets/ab

@@ -1,5 +0,0 @@
-# send 100 requests with a concurency of 50 requests to an URL
-ab -n 100 -c 50 http://www.example.com/
-
-# send requests during 30 seconds with a concurency of 50 requests to an URL
-ab -t 30 -c 50 URL http://www.example.com/

cheat/cheatsheets/apk

@@ -1,14 +0,0 @@
-# Install a package
-apk add $package
-
-# Remove a package
-apk del $package
-
-# Update repos
-apk update
-
-# Upgrade all packages
-apk upgrade
-
-# Find a package
-apk search $package

cheat/cheatsheets/apparmor

@@ -1,18 +0,0 @@
-# Desc: Apparmor will protect the system by confining programs to a limited set of resources.
-
-# To activate a profile:
-sudo aa-enforce usr.bin.firefox
-# OR
-export _PROFILE_='usr.bin.firefox' sudo $(rm /etc/apparmor.d/disable/$_PROFILE_ ; cat /etc/apparmor.d/$_PROFILE_ | apparmor_parser -a )
-
-# TO disable a profile:
-sudo aa-disable usr.bin.firefox
-# OR
-export _PROFILE_='usr.bin.firefox' sudo $(ln -s /etc/apparmor.d/$_PROFILE_ /etc/apparmor.d/disable/ && apparmor_parser -R /etc/apparmor.d/$_PROFILE_)
-
-# To list profiles loaded:
-sudo aa-status
-# OR
-sudo apparmor_status
-
-# List of profiles aviables: /etc/apparmor.d/

cheat/cheatsheets/apt-cache

@@ -1,12 +0,0 @@
-# To search for apt packages:
-apt-cache search "whatever"
-
-# To display package records for the named package(s):
-apt-cache show pkg(s)
-
-# To display reverse dependencies of a package
-apt-cache rdepends package_name
-
-# To display package versions, reverse dependencies and forward dependencies 
-# of a package
-apt-cache showpkg package_name

cheat/cheatsheets/apt-get

@@ -1,25 +0,0 @@
-# Desc: Allows to update the operating system
-
-# To fetch package list
-apt-get update
-
-# To download and install updates without installing new package.
-apt-get update
-
-# To download and install the updates AND install new necessary packages
-apt-get dist-upgrade
-
-# Full command:
-apt-get update && apt-get dist-upgrade
-
-# To install a new package(s)
-apt-get install package(s)
-
-# Download a package without installing it. (The package will be downloaded in your current working dir)
-apt-get download modsecurity-crs
-
-# Change Cache dir and archive dir (where .deb are stored).
-apt-get -o Dir::Cache="/path/to/destination/dir/" -o Dir::Cache::archives="./" install ...
-
-# Show apt-get installed packages.
-grep 'install ' /var/log/dpkg.log

cheat/cheatsheets/aptitude

@@ -1,15 +0,0 @@
-# To search for packages:
-aptitude search "whatever"
-
-# To display package records for the named package(s):
-aptitude show pkg(s)
-
-# To install a package:
-aptitude install package
-
-# To remove a package:
-aptitude remove package
-
-# To remove unnecessary package:
-aptitude autoclean
-

cheat/cheatsheets/asciiart

@@ -1,22 +0,0 @@
-# To show some text in ASCII Art:
-
-figlet Cheat
-#  ____ _                _
-# / ___| |__   ___  __ _| |_
-#| |   | '_ \ / _ \/ _` | __|
-#| |___| | | |  __/ (_| | |_
-# \____|_| |_|\___|\__,_|\__|
-#
-
-
-# To have some text with color and other options:
-# Show with a border
-toilet -F border Cheat
-# Basic show (filled)
-toilet Cheat
-#   mmm  #                      m
-# m"   " # mm    mmm    mmm   mm#mm
-# #      #"  #  #"  #  "   #    #
-# #      #   #  #""""  m"""#    #
-#  "mmm" #   #  "#mm"  "mm"#    "mm
-#

cheat/cheatsheets/asterisk

@@ -1,17 +0,0 @@
-# To connect to a running Asterisk session:
-asterisk -rvvv
-
-# To issue a command to Asterisk from the shell:
-asterisk -rx "<command>"
-
-# To originate an echo call from a SIP trunk on an Asterisk server, to a specified number:
-asterisk -rx "channel originate SIP/<trunk>/<number> application echo"
-
-# To print out the details of SIP accounts:
-asterisk -rx "sip show peers"
-
-# To print out the passwords of SIP accounts:
-asterisk -rx "sip show users"
-
-# To print out the current active channels:
-asterisk -rx "core show channels"

cheat/cheatsheets/at

@@ -1,17 +0,0 @@
-# To schedule a one time task
-at {time}
-{command 0}
-{command 1}
-Ctrl-d
-
-# {time} can be either
-now | midnight | noon | teatime (4pm)
-HH:MM
-now + N {minutes | hours | days | weeks}
-MM/DD/YY
-
-# To list pending jobs
-atq
-
-# To remove a job (use id from atq)
-atrm {id}

cheat/cheatsheets/awk

@@ -1,2 +0,0 @@
-# sum integers from a file or stdin, one integer per line:
-printf '1\n2\n3\n' | awk '{ sum += $1} END {print sum}'

cheat/cheatsheets/bash

@@ -1,14 +0,0 @@
-# To implement a for loop:
-for file in `ls .`;
-do 
-    echo $file found;
-done
-
-# To implement a case command:
-case "$1"
-in
-    0) echo "zero found";;
-    1) echo "one found";;
-    2) echo "two found";;
-    3*) echo "something beginning with 3 found";;
-esac

cheat/cheatsheets/chmod

@@ -1,36 +0,0 @@
-# Add execute for all (myscript.sh)
-chmod a+x myscript.sh
-
-# Set user to read/write/execute, group/global to read only (myscript.sh), symbolic mode
-chmod u=rwx, go=r myscript.sh 
-
-# Remove write from user/group/global (myscript.sh), symbolic mode
-chmod a-w myscript.sh
-
-# Remove read/write/execute from user/group/global (myscript.sh), symbolic mode
-chmod = myscript.sh
-
-# Set user to read/write and group/global read (myscript.sh), octal notation
-chmod 644 myscript.sh
-
-# Set user to read/write/execute and group/global read/execute (myscript.sh), octal notation
-chmod 755 myscript.sh
-
-# Set user/group/global to read/write (myscript.sh), octal notation
-chmod 666 myscript.sh
-
-# Roles
-u - user (owner of the file)
-g - group (members of file's group)
-o - global (all users who are not owner and not part of group)
-a - all (all 3 roles above)
-
-# Numeric representations
-7 - full (rwx)
-6 - read and write (rw-)
-5 - read and execute (r-x)
-4 - read only (r--)
-3 - write and execute (-wx)
-2 - write only (-w-)
-1 - execute only (--x)
-0 - none (---)

cheat/cheatsheets/chown

@@ -1,11 +0,0 @@
-# Change file owner
-chown user file
-
-# Change file owner and group
-chown user:group file
-
-# Change owner recursively
-chown -R user directory
-
-# Change ownership to match another file
-chown --reference=/path/to/ref_file file

cheat/cheatsheets/convert

@@ -1,19 +0,0 @@
-# To resize an image to a fixed width and proportional height:
-convert original-image.jpg -resize 100x converted-image.jpg
-
-# To resize an image to a fixed height and proportional width:
-convert original-image.jpg -resize x100 converted-image.jpg
-
-# To resize an image to a fixed width and height:
-convert original-image.jpg -resize 100x100 converted-image.jpg
-
-# To resize an image and simultaneously change its file type:
-convert original-image.jpg -resize 100x converted-image.png
-
-# To resize all of the images within a directory:
-# To implement a for loop:
-for file in `ls original/image/path/`;
-    do new_path=${file%.*};
-    new_file=`basename $new_path`;
-    convert $file -resize 150 conerted/image/path/$new_file.png;
-done

cheat/cheatsheets/crontab

@@ -1,20 +0,0 @@
-# set a shell
-SHELL=/bin/bash
-
-# crontab format
-* * * * *  command_to_execute
-- - - - -
-| | | | |
-| | | | +- day of week (0 - 7) (where sunday is 0 and 7)
-| | | +--- month (1 - 12)
-| | +----- day (1 - 31)
-| +------- hour (0 - 23)
-+--------- minute (0 - 59)
-
-# example entries
-# every 15 min
-*/15 * * * * /home/user/command.sh
-# every midnight
-0 * * * * /home/user/command.sh
-# every Saturday at 8:05 AM
-5 8 * * 6 /home/user/command.sh

cheat/cheatsheets/curl

@@ -1,35 +0,0 @@
-# Download a single file
-curl http://path.to.the/file
-
-# Download a file and specify a new filename
-curl http://example.com/file.zip -o new_file.zip
-
-# Download multiple files
-curl -O URLOfFirstFile -O URLOfSecondFile
-
-# Download all sequentially numbered files (1-24)
-curl http://example.com/pic[1-24].jpg
-
-# Download a file and pass HTTP Authentication
-curl -u username:password URL 
-
-# Download a file with a Proxy
-curl -x proxysever.server.com:PORT http://addressiwantto.access
-
-# Download a file from FTP
-curl -u username:password -O ftp://example.com/pub/file.zip
-
-# Get an FTP directory listing
-curl ftp://username:password@example.com
-
-# Resume a previously failed download
-curl -C - -o partial_file.zip http://example.com/file.zip
-
-# Fetch only the HTTP headers from a response
-curl -I http://example.com
-
-# Fetch your external IP and network info as JSON
-curl http://ifconfig.me/all/json
-
-# Limit the rate of a download
-curl --limit-rate 1000B -O http://path.to.the/file

cheat/cheatsheets/cut

@@ -1,2 +0,0 @@
-# To cut out the third field of text or stdoutput that is delimited by a #:
-cut -d# -f3

cheat/cheatsheets/date

@@ -1,2 +0,0 @@
-# Printout date in format suitable for affixing to file names
-date +"%Y%m%d_%H%M%S"

cheat/cheatsheets/dd

@@ -1,17 +0,0 @@
-# Read from {/dev/urandom} 2*512 Bytes and put it into {/tmp/test.txt}
-# Note: At the first iteration, we read 512 Bytes.
-# Note: At the second iteration, we read 512 Bytes.
-dd if=/dev/urandom of=/tmp/test.txt count=512 bs=2
-
-# Watch the progress of 'dd'
-dd if=/dev/zero of=/dev/null bs=4KB &; export dd_pid=`pgrep '^dd'`; while [[ -d /proc/$dd_pid ]]; do kill -USR1 $dd_pid && sleep 1 && clear; done
-
-# Watch the progress of 'dd' with `pv` and `dialog` (apt-get install pv dialog)
-(pv -n /dev/zero | dd of=/dev/null bs=128M conv=notrunc,noerror) 2>&1 | dialog --gauge "Running dd command (cloning), please wait..." 10 70 0
-
-# Watch the progress of 'dd' with `pv` and `zenity` (apt-get install pv zenity)
-(pv -n /dev/zero | dd of=/dev/null bs=128M conv=notrunc,noerror) 2>&1 | zenity --title 'Running dd command (cloning), please wait...' --progress
-
-# DD with "graphical" return
-dcfldd if=/dev/zero of=/dev/null bs=500K
-

cheat/cheatsheets/df

@@ -1,2 +0,0 @@
-# Printout disk free space in a human readable format
-df -h

cheat/cheatsheets/dhclient

@@ -1,10 +0,0 @@
-# To release the current IP address:
-sudo dhclient -r
-
-# To obtain a new IP address:
-sudo dhclient
-
-# Running the above in sequence is a common way of refreshing an IP.
-
-# To obtain a new IP address for a specific interface:
-sudo dhclient eth0

cheat/cheatsheets/diff

@@ -1,23 +0,0 @@
-# To view the differences between two files:
-diff -u version1 version2
-
-# To view the differences between two directories:
-diff -ur folder1/ folder2/
-
-# To ignore the white spaces:
-diff -ub version1 version2
-
-# To ignore the blank lines:
-diff -uB version1 version2
-
-# To ignore the differences between uppercase and lowercase:
-diff -ui version1 version2
-
-# To report whether the files differ:
-diff -q version1 version2
-
-# To report whether the files are identical:
-diff -s version1 version2
-
-# To diff the output of two commands or scripts:
-diff <(command1) <(command2)

cheat/cheatsheets/distcc

@@ -1,29 +0,0 @@
-# INSTALL
-# ==============================================================================
-# Edit /etc/default/distcc and set theses vars
-# STARTDISTCC="true"
-# ALLOWEDNETS="127.0.0.1 192.168.1.0/24"# Your computer and local computers
-# #LISTENER="127.0.0.1"# Comment it
-# ZEROCONF="true"# Auto configuration
-
-# REMEMBER 1:
-# Start/Restart your distccd servers before using one of these commands.
-# service distccd start
-
-# REMEMBER 2:
-# Do not forget to install on each machine DISTCC.
-# No need to install libs ! Only main host need libs !
-
-# USAGE
-# ==============================================================================
-
-# Run make with 4 thread (a cross network) in auto configuration.
-# Note: for gcc, Replace CXX by CC and g++ by gcc
-ZEROCONF='+zeroconf' make -j4 CXX='distcc g++'
-
-# Run make with 4 thread (a cross network) in static configuration (2 ip)
-# Note: for gcc, Replace CXX by CC and g++ by gcc
-DISTCC_HOSTS='127.0.0.1 192.168.1.69' make -j4 CXX='distcc g++'
-
-# Show hosts aviables
-ZEROCONF='+zeroconf' distcc --show-hosts

cheat/cheatsheets/emacs

@@ -1,70 +0,0 @@
-# Basic usage
-
-  Indent              Select text then press TAB
-  Cut                 CTRL-w
-  Copy                ALT-w
-  Paste               CTRL-y
-  Search/Find         CTRL-s
-  Replace             ALT-% (ALT-SHIFT-5)
-  Save                CTRL-x CTRL-s
-  Load/Open           CTRL-x CTRL-f
-  Undo                CTRL-x u
-  Highlight all text  CTRL-x h
-  Directory listing   CTRL-x d
-  Cancel a command    ESC ESC ESC
-  Font size bigger    CTRL-x CTRL-+
-  Font size smaller   CTRL-x CTRL--
-
-#  Buffers
-
-  Split screen vertically                         CTRL-x 2
-  Split screen vertically with 5 row height       CTRL-u 5 CTRL-x 2
-  Split screen horizontally                       CTRL-x 3
-  Split screen horizontally with 24 column width  CTRL-u 24 CTRL-x 3
-  Revert to single screen                         CTRL-x 1
-  Hide the current screen                         CTRL-x 0
-  Kill the current screen                         CTRL-x k
-  Move to the next buffer                         CTRL-x O
-  Select a buffer                                 CTRL-x b
-  Run command in the scratch buffer               CTRL-x CTRL-e
-
-# Other stuff
-
-  Open a shell         ALT-x eshell
-  Goto a line number   ALT-x goto-line
-  Word wrap            ALT-x toggle-word-wrap
-  Spell checking       ALT-x flyspell-mode
-  Line numbers         ALT-x linum-mode
-  Toggle line wrap     ALT-x visual-line-mode
-  Compile some code    ALT-x compile
-  List packages        ALT-x package-list-packages
-
-#  Sudoing within eshell
-
-  By default when using the sudo command within eshell you'll just
-  get "permission denied" messages. To overcome that type:
-
-    alias sudo '*sudo $*'
-
-# Line numbers
-
-  To add line numbers and enable moving to a line with CTRL-l:
-
-    (global-set-key "\C-l" 'goto-line)
-    (add-hook 'find-file-hook (lambda () (linum-mode 1)))
-
-# Org-mode
-
-  To begin org-mode                            ALT-x org-mode
-  Table column separator                       Vertical/pipe character
-  Reorganize table                             TAB
-  Section heading                              *
-  Open/collapse section                        TAB
-  Open/collapse All                            CTRL-TAB
-  Export in other file formats (eg HTML,PDF)   CTRL-c CTRL-e
-
-  To make org-mode automatically wrap lines:
-
-    (add-hook 'org-mode-hook
-              '(lambda ()
-                 (visual-line-mode 1)))

cheat/cheatsheets/find

@@ -1,44 +0,0 @@
-# To find files by case-insensitive extension (ex: .jpg, .JPG, .jpG):
-find . -iname "*.jpg"
-
-# To find directories:
-find . -type d
-
-# To find files:
-find . -type f
-
-# To find files by octal permission:
-find . -type f -perm 777
-
-# To find files with setuid bit set:
-find . -xdev \( -perm -4000 \) -type f -print0 | xargs -0 ls -l
-
-# To find files with extension '.txt' and remove them:
-find ./path/ -name '*.txt' -exec rm '{}' \;
-
-# To find files with extension '.txt' and look for a string into them:
-find ./path/ -name '*.txt' | xargs grep 'string'
-
-# To find files with size bigger than 5 Mb and sort them by size:
-find ./ -size +5M -type f -print0 | xargs -0 ls -Ssh
-
-# To find files bigger thank 2 MB and list them:
-find / -type f -size +20000k -exec ls -lh {} \; | awk '{ print $9 ": " $5 }'
-
-# To find files modified more than 7 days ago and list file information
-find . -type f -mtime +7d -ls
-
-# To find symlinks owned by a user and list file information
-find . -type l --user=username -ls
-
-# To search for and delete empty directories
-find . -type d -empty -exec rmdir {} \;
-
-# To search for directories named build at a max depth of 2 directories
-find . -maxdepth 2 -name build -type d
-
-# To search all files who are not in .git directory
-find . ! -iwholename '*.git*' -type f
-
-# Find all files that have the same node (hard link) as MY_FILE_HERE
-find / -type f -samefile MY_FILE_HERE 2>/dev/null

cheat/cheatsheets/gcc

@@ -1,21 +0,0 @@
-# Compile a file
-gcc file.c
-
-# Compile a file with a custom output
-gcc -o file file.c
-
-# Debug symbols
-gcc -g
-
-# Debug with all symbols.
-gcc -ggdb3
-
-# Build for 64 bytes
-gcc -m64
-
-# Include the directory {/usr/include/myPersonnal/lib/} to the list of path for #include <....>
-# With this option, no warning / error will be reported for the files in {/usr/include/myPersonnal/lib/}
-gcc -isystem /usr/include/myPersonnal/lib/
-
-# Build a GUI for windows (Mingw) (Will disable the term/console)
-gcc -mwindows

cheat/cheatsheets/gdb

@@ -1,26 +0,0 @@
-# start the debugger
-gdb your-executable
-
-# set a breakpoint
-b some-method, break some-method
-
-# run the program
-r, run
-
-# when a breakpoint was reached:
-
-# run the current line, stepping over any invocations
-n, next
-# run the current line, stepping into any invocations
-s, step
-# print a stacktrace
-bt, backtrace
-# evaluate an expression and print the result
-p length=strlen(string)
-# list surrounding source code
-l, list
-# continue execution
-c, continue
-
-# exit gdb (after program terminated)
-q, quit

cheat/cheatsheets/git

@@ -1,53 +0,0 @@
-# To set your identify:
-git config --global user.name "John Doe"
-git config --global user.email johndoe@example.com
-
-# To set your editor:
-git config --global core.editor emacs
-
-# To enable color:
-git config --global color.ui true
-
-# To stage all changes for commit:
-git add --all
-
-# To commit staged changes
-git commit -m "Your commit message"
-
-# To edit previous commit message
-git commit --amend
-
-# To removed staged and working directory changes
-git reset --hard
-
-# To remove untracked files
-git clean -f -d
-
-# To remove untracked and ignored files
-git clean -f -d -x
-
-# To push to the tracked master branch:
-git push origin master
-
-# To push to a specified repository:
-git push git@github.com:username/project.git
-
-# To delete the branch "branch_name"
-git branch -D branch_name
-
-# To see who commited which line in a file
-git blame filename
-
-# To sync a fork with the master repo:
-git remote add upstream git@github.com:name/repo.git    # Set a new repo
-git remote -v                                           # Confirm new remote repo
-git fetch upstream                                      # Get branches
-git branch -va                                          # List local - remote branches
-git checkout master                                     # Checkout local master branch
-git checkout -b new_branch                              # Create and checkout a new branch
-git merge upstream/master                               # Merge remote into local repo
-git show 83fb499                                        # Show what a commit did.
-git show 83fb499:path/fo/file.ext                       # Shows the file as it appeared at 83fb499.
-git diff branch_1 branch_2                              # Check difference between branches
-git log                                                 # Show all the commits
-git status                                              # Show the changes from last commit

cheat/cheatsheets/gpg

@@ -1,173 +0,0 @@
-# Create a key
-
- gpg --gen-key
-
-
-# Show keys
-
-  To list a summary of all keys
-
-    gpg --list-keys
-
-  To show your public key
-
-    gpg --armor --export
-
-  To show the fingerprint for a key
-
-    gpg --fingerprint KEY_ID
-
-# Search for keys
-
-  gpg --search-keys 'user@emailaddress.com'
-
-
-# To Encrypt a File
-
-  gpg --encrypt --recipient 'user@emailaddress.com' example.txt
-
-
-# To Decrypt a File
-
-  gpg --output example.txt --decrypt example.txt.gpg
-
-
-# Export keys
-
-  gpg --output ~/public_key.txt --armor --export KEY_ID
-  gpg --output ~/private_key.txt --armor --export-secret-key KEY_ID
-
-  Where KEY_ID is the 8 character GPG key ID.
-
-  Store these files to a safe location, such as a USB drive, then
-  remove the private key file.
-
-    shred -zu ~/private_key.txt
-
-# Import keys
-
-  Retrieve the key files which you previously exported.
-
-    gpg --import ~/public_key.txt
-    gpg --allow-secret-key-import --import ~/private_key.txt
-
-  Then delete the private key file.
-
-    shred -zu ~/private_key.txt
-
-# Revoke a key
-
-  Create a revocation certificate.
-
-    gpg --output ~/revoke.asc --gen-revoke KEY_ID
-
-  Where KEY_ID is the 8 character GPG key ID.
-
-  After creating the certificate import it.
-
-    gpg --import ~/revoke.asc
-
-  Then ensure that key servers know about the revokation.
-
-    gpg --send-keys KEY_ID
-
-# Signing and Verifying files
-
-  If you're uploading files to launchpad you may also want to include
-  a GPG signature file.
-
-    gpg -ba filename
-
-  or if you need to specify a particular key:
-
-    gpg --default-key <key ID> -ba filename
-
-  This then produces a file with a .asc extension which can be uploaded.
-  If you need to set the default key more permanently then edit the
-  file ~/.gnupg/gpg.conf and set the default-key parameter.
-
-  To verify a downloaded file using its signature file.
-
-  gpg --verify filename.asc
-
-# Signing Public Keys
-
-  Import the public key or retrieve it from a server.
-
-    gpg --keyserver <keyserver> --recv-keys <Key_ID>
-
-  Check its fingerprint against any previously stated value.
-
-    gpg --fingerprint <Key_ID>
-
-  Sign the key.
-
-    gpg --sign-key <Key_ID>
-
-  Upload the signed key to a server.
-
-    gpg --keyserver <keyserver> --send-key <Key_ID>
-
-# Change the email address associated with a GPG key
-
-  gpg --edit-key <key ID>
-  adduid
-
-  Enter the new name and email address. You can then list the addresses with:
-
-    list
-
-  If you want to delete a previous email address first select it:
-
-    uid <list number>
-
-  Then delete it with:
-
-    deluid
-
-  To finish type:
-
-    save
-
-  Publish the key to a server:
-
-    gpg --send-keys <key ID>
-
-# Creating Subkeys
-
-  Subkeys can be useful if you don't wish to have your main GPG key
-  installed on multiple machines. In this way you can keep your
-  master key safe and have subkeys with expiry periods or which may be
-  separately revoked installed on various machines. This avoids
-  generating entirely separate keys and so breaking any web of trust
-  which has been established.
-
-    gpg --edit-key <key ID>
-
-  At the prompt type:
-
-    addkey
-
-  Choose RSA (sign only), 4096 bits and select an expiry period.
-  Entropy will be gathered.
-
-  At the prompt type:
-
-    save
-
-  You can also repeat the procedure, but selecting RSA (encrypt only).
-  To remove the master key, leaving only the subkey/s in place:
-
-    gpg --export-secret-subkeys <subkey ID> > subkeys
-    gpg --export <key ID> > pubkeys
-    gpg --delete-secret-key <key ID>
-
-  Import the keys back.
-
-    gpg --import pubkeys subkeys
-
-  Verify the import.
-
-    gpg -K
-
-  Should show sec# instead of just sec.

cheat/cheatsheets/grep

@@ -1,26 +0,0 @@
-# Basic:
-grep pattern file
-
-# case nonsensitive research:
-grep -i pattern file
-
-# Recursively grep for string <pattern> in folder:
-grep -R pattern folder
-
-# Getting pattern from file (one by line):
-grep -f pattern_file file
-
-# Find lines NOT containing pattern
-grep -v pattern file
-
-# You can grep with regular expressions
-grep "^00" file  #Match lines starting with 00
-grep -E "[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}" file  #Find IP add
-
-# Find all files who contain {pattern} in the directory {directory}.
-# This will show: "file:line my research"
-grep -rnw 'directory' -e "pattern"
-
-# Exclude grep from your grepped output of ps.
-# Add [] to the first letter. Ex: sshd -> [s]shd
-ps aux | grep '[h]ttpd'

cheat/cheatsheets/gs

@@ -1,3 +0,0 @@
-# To reduce the size of a pdf file:
-gs -dBATCH -dNOPAUSE -q -sDEVICE=pdfwrite -sOutputFile=output.pdf input.pdf
-

cheat/cheatsheets/head

@@ -1,8 +0,0 @@
-# To show the first 10 lines of file
-head file
-
-# To show the first N lines of file
-head -n N file
-
-# To show the first N bytes of file
-head -c N file

cheat/cheatsheets/history

@@ -1,3 +0,0 @@
-# To see most used top 10 commands:
-history | awk '{CMD[$2]++;count++;}END { for (a in CMD)print CMD[a] " " CMD[a]/count*100 "% " a;}' | grep -v "./" | column -c3 -s " " -t | sort -nr | nl | head -n10
-

cheat/cheatsheets/ifconfig

@@ -1,14 +0,0 @@
-# Display network settings of the first ethernet adapter
-ifconfig wlan0
-
-# Display all interfaces, even if down
-ifconfig -a
-
-# Take down / up the wireless adapter
-ifconfig wlan0 {up|down} 
-
-# Set a static IP and netmask
-ifconfig eth0 192.168.1.100 netmask 255.255.255.0
-
-# You may also need to add a gateway IP
-route add -net 192.168.1.0 netmask 255.255.255.0 gw 192.168.1.1

cheat/cheatsheets/indent

@@ -1,2 +0,0 @@
-# format C/C++ source according to the style of Kernighan and Ritchie (K&R), no tabs, 3 spaces per indent, wrap lines at 120 characters.
-indent -i3 -kr -nut -l120

cheat/cheatsheets/iptables

@@ -1,40 +0,0 @@
-# Show hit for rules with auto refresh
-watch --interval 0 'iptables -nvL | grep -v "0     0"'
-
-# Show hit for rule with auto refresh and highlight any changes since the last refresh
-watch -d -n 2 iptables -nvL
-
-# Block the port 902 and we hide this port from nmap.
-iptables -A INPUT -i eth0 -p tcp --dport 902 -j REJECT --reject-with icmp-port-unreachable
-
-# Note, --reject-with accept:
-#	icmp-net-unreachable
-#	icmp-host-unreachable
-#	icmp-port-unreachable <- Hide a port to nmap
-#	icmp-proto-unreachable
-#	icmp-net-prohibited
-#	icmp-host-prohibited or
-#	icmp-admin-prohibited
-#	tcp-reset
-
-# Add a comment to a rule:
-iptables ... -m comment --comment "This rule is here for this reason"
-
-
-# To remove or insert a rule:
-# 1) Show all rules
-iptables -L INPUT --line-numbers
-# OR iptables -nL --line-numbers
-
-# Chain INPUT (policy ACCEPT)
-#     num  target prot opt source destination
-#     1    ACCEPT     udp  --  anywhere  anywhere             udp dpt:domain
-#     2    ACCEPT     tcp  --  anywhere  anywhere             tcp dpt:domain
-#     3    ACCEPT     udp  --  anywhere  anywhere             udp dpt:bootps
-#     4    ACCEPT     tcp  --  anywhere  anywhere             tcp dpt:bootps
-
-# 2.a) REMOVE (-D) a rule. (here an INPUT rule)
-iptables -D INPUT 2
-
-# 2.b) OR INSERT a rule.
-iptables -I INPUT {LINE_NUMBER} -i eth1 -p tcp --dport 21 -s 123.123.123.123 -j ACCEPT -m comment --comment "This rule is here for this reason"

cheat/cheatsheets/irssi

@@ -1,26 +0,0 @@
-# To connect to an IRC server
-/connect <server domain name>
-
-# To join a channel
-/join #<channel name>
-
-# To set a nickname
-/nick <my nickname>
-
-# To send a private message to a user
-/msg <nickname>
-
-# To close the current channel window
-/wc
-
-# To switch between channel windows
-ALT+<number>, eg. ALT+1, ALT+2
-
-# To list the nicknames within a channel
-/names
-
-# To change the topic
-/topic <description>
-
-# To quit irssi
-/exit

cheat/cheatsheets/iwconfig

@@ -1,8 +0,0 @@
-# Display wireless settings of the first wireless adapter
-iwconfig wlan0
-
-# Take down / up the wireless adapter
-iwconfig wlan0 txpower {on|auto|off}
-
-# Change the mode of the wireless adapter
-iwconfig wlan0 mode {managed|ad-hoc|monitor}

cheat/cheatsheets/journalctl

@@ -1,21 +0,0 @@
-# Actively follow log (like tail -f)
-journalctl -f
-
-# Display all errors since last boot
-journalctl -b -p err
-
-# Filter by time period
-journalctl --since=2012-10-15 --until="2011-10-16 23:59:59"
-
-# Show list of systemd units logged in journal
-journalctl -F _SYSTEMD_UNIT
-
-# Filter by specific unit
-journalctl -u dbus
-
-# Filter by executable name
-journalctl /usr/bin/dbus-daemon
-
-# Filter by PID
-journalctl _PID=123
-

cheat/cheatsheets/less

@@ -1,2 +0,0 @@
-# To disable the terminal refresh when exiting
-less -X

cheat/cheatsheets/ln

@@ -1,2 +0,0 @@
-# To create a symlink:
-ln -s path/to/the/target/directory name-of-symlink

cheat/cheatsheets/ls

@@ -1,11 +0,0 @@
-# Displays everything in the target directory
-ls path/to/the/target/directory
-
-# Displays everything including hidden files
-ls -a
-
-# Displays all files, along with the size (with unit suffixes) and timestamp
-ls -lh 
-
-# Display files, sorted by size
-ls -S

cheat/cheatsheets/lsof

@@ -1,23 +0,0 @@
-# List all IPv4 network files
-sudo lsof -i4
-
-# List all IPv6 network files
-sudo lsof -i6
-
-# To find listening ports:
-lsof -Pnl +M -i4
-
-# To find which program is using the port 80:
-lsof -i TCP:80
-
-# List all processes accessing a particular file/directory
-lsof </path/to/file>
-
-# List all files open for a particular user
-lsof -u <username>
-
-# List all files/network connections a given process is using
-lsof -c <command-name>
-
-# See this primer: http://www.danielmiessler.com/study/lsof/
-# for a number of other useful lsof tips

cheat/cheatsheets/markdown

@@ -1,41 +0,0 @@
-# headers
-h1 header
-=========
-h2 header
----------
-
-# blockquotes
-> first level and paragraph
->> second level and first paragraph
->
-> first level and second paragraph
-
-# lists
-## unordered - use *, +, or -
-        * Red
-        * Green
-        * Blue
-
-## ordered
-        1. First
-        2. Second
-        3. Third
-
-# code - use 4 spaces/1 tab
-regular text
-        code code code
-or:
-Use the `printf()` function
-
-# hr's - three or more of the following
-***
----
-___
-
-# links
-This is [an example](http://example.com "Title") inline link.
-
-# emphasis
-*em* _em_
-
-**strong** __strong__

cheat/cheatsheets/mkdir

@@ -1,9 +0,0 @@
-# Create a directory and all its parents
-mkdir -p foo/bar/baz
-
-# Create foo/bar and foo/baz directories
-mkdir -p foo/{bar,baz}
-
-# Create the foo/bar, foo/baz, foo/baz/zip and foo/baz/zap directories
-mkdir -p foo/{bar,baz/{zip,zap}}
-

cheat/cheatsheets/mount

@@ -1,8 +0,0 @@
-# To mount / partition as read-write in repair mode:
-mount -o remount,rw /
-
-# To mount Usb disk as user writable:
-mount -o uid=username,gid=usergroup /dev/sdx /mnt/xxx
-
-# To mount a remote NFS directory
-mount -t nfs example.com:/remote/example/dir /local/example/dir

cheat/cheatsheets/mysql

@@ -1,14 +0,0 @@
-# To connect to a database
-mysql -h localhost -u root -p
-
-# To backup all databases
-mysqldump --all-databases --all-routines -u root -p > ~/fulldump.sql
-
-# To restore all databases
-mysql -u root -p  < ~/fulldump.sql
-
-# To create a database in utf8 charset
-CREATE DATABASE owa CHARACTER SET utf8 COLLATE utf8_general_ci;
-
-# To add a user and give rights on the given database
-GRANT ALL PRIVILEGES ON database.* TO 'user'@'localhost'IDENTIFIED BY 'password' WITH GRANT OPTION;

cheat/cheatsheets/mysqldump

@@ -1,23 +0,0 @@
- # To dump a database to a file (Note that your password will appear in your command history!):
-mysqldump -uusername -ppassword the-database > db.sql
-
-# To dump a database to a file:
-mysqldump -uusername -p the-database > db.sql
-
- # To dump a database to a .tgz file (Note that your password will appear in your command history!):
-mysqldump -uusername -ppassword the-database | gzip -9 > db.sql
-
-# To dump a database to a .tgz file:
-mysqldump -uusername -p the-database | gzip -9 > db.sql
-
- # To dump all databases to a file (Note that your password will appear in your command history!):
-mysqldump -uusername -ppassword --all-databases > all-databases.sql
-
-# To dump all databases to a file:
-mysqldump -uusername -p --all-databases > all-databases.sql
-
-# To export the database structure only:
-mysqldump --no-data -uusername -p the-database > dump_file
-
-# To export the database data only:
-mysqldump --no-create-info -uusername -p the-database > dump_file

cheat/cheatsheets/ncat

@@ -1,30 +0,0 @@
-# Connect mode (ncat is client) | default port is 31337
-ncat <host> [<port>]
-
-# Listen mode (ncat is server) | default port is 31337
-ncat -l [<host>] [<port>]
-
-# Transfer file (closes after one transfer)
-ncat -l [<host>] [<port>] < file
-
-# Transfer file (stays open for multiple transfers)
-ncat -l --keep-open [<host>] [<port>] < file
-
-# Receive file
-ncat [<host>] [<port>] > file
-
-# Brokering | allows for multiple clients to connect
-ncat -l --broker [<host>] [<port>]
-
-# Listen with SSL | many options, use ncat --help for full list
-ncat -l --ssl [<host>] [<port>]
-
-# Access control
-ncat -l --allow <ip>
-ncat -l --deny <ip>
-
-# Proxying
-ncat --proxy <proxyhost>[:<proxyport>] --proxy-type {http | socks4} <host>[<port>]
-
-# Chat server | can use brokering for multi-user chat
-ncat -l --chat [<host>] [<port>]

cheat/cheatsheets/netstat

@@ -1,28 +0,0 @@
-# WARNING ! netstat is deprecated. Look below.
-
-# To view which users/processes are listening to which ports:
-sudo netstat -lnptu
-
-# To view routing table (use -n flag to disable DNS lookups):
-netstat -r
-
-# Which process is listening to port <port>
-netstat -pln | grep <port> | awk '{print $NF}'
-
-Example output: 1507/python
-
-# Fast display of ipv4 tcp listening programs
-sudo netstat -vtlnp --listening -4
-
-# WARNING ! netstat is deprecated.
-# Replace it by:
-ss
-
-# For netstat-r
-ip route
-
-# For netstat -i
-ip -s link
-
-# For netstat-g
-ip maddr

cheat/cheatsheets/nmap

@@ -1,57 +0,0 @@
-# Single target scan:
-nmap [target]
-
-# Scan from a list of targets:
-nmap -iL [list.txt]
-
-# iPv6:
-nmap -6 [target]
-
-# OS detection:
-nmap -O --osscan_guess [target]
-
-# Save output to text file:
-nmap -oN [output.txt] [target]
-
-# Save output to xml file:
-nmap -oX [output.xml] [target]
-
-# Scan a specific port:
-nmap -source-port [port] [target]
-
-# Do an aggressive scan:
-nmap -A [target]
-
-# Speedup your scan:
-nmap -T5 --min-parallelism=50 [target]
-
-# Traceroute:
-nmap -traceroute [target]
-
-# Ping scan only: -sP
-# Don't ping:     -PN
-# TCP SYN ping:   -PS
-# TCP ACK ping:   -PA
-# UDP ping:       -PU
-# ARP ping:       -PR
-
-# Example: Ping scan all machines on a class C network
-nmap -sP 192.168.0.0/24
-
-# Use some script:
-nmap --script default,safe
-
-# Loads the script in the default category, the banner script, and all .nse files in the directory /home/user/customscripts.
-nmap --script default,banner,/home/user/customscripts
-
-# Loads all scripts whose name starts with http-, such as http-auth and http-open-proxy.
-nmap --script 'http-*'
-
-# Loads every script except for those in the intrusive category.
-nmap --script "not intrusive"
-
-# Loads those scripts that are in both the default and safe categories.
-nmap --script "default and safe"
-
-# Loads scripts in the default, safe, or intrusive categories, except for those whose names start with http-.
-nmap --script "(default or safe or intrusive) and not http-*"

cheat/cheatsheets/notify-send

@@ -1,4 +0,0 @@
-# To send a desktop notification via dbus:
-notify-send -i 'icon-file/name' -a 'application_name' 'summary' 'body of message'
-
-# The -i and -a flags can be omitted if unneeded.

cheat/cheatsheets/od

@@ -1,11 +0,0 @@
-# Dump file in octal format
-od /path/to/binaryfile
-od -o /path/to/binaryfile
-od -t o2 /path/to/binaryfile
-
-# Dump file in hexadecimal format
-od -x /path/to/binaryfile
-od -t x2 /path/to/binaryfile
-
-# Dump file in hexadecimal format, with hexadecimal offsets and a space between each byte
-od -A x -t x1 /path/to/binaryfile

cheat/cheatsheets/openssl

@@ -1,21 +0,0 @@
-# To create a 2048-bit private key:
-openssl genrsa -out server.key 2048
-
-# To create the Certificate Signing Request (CSR):
-openssl req -new -key server.key -out server.csr
-
-# To sign a certificate using a private key and CSR:
-openssl x509 -req -days 365 -in server.csr -signkey server.key -out server.crt
-
-# (The above commands may be run in sequence to generate a self-signed SSL certificate.)
-
-# To show certificate information for a certificate signing request
-openssl req -text -noout -in server.csr
-
-# To show certificate information for generated certificate
-openssl x509 -text -noout -in server.crt 
-
-# To view certificate expiration:
-echo | openssl s_client -connect <hostname>:443 2> /dev/null | \
-awk '/-----BEGIN/,/END CERTIFICATE-----/' | \
-openssl x509 -noout -enddate

cheat/cheatsheets/pacman

@@ -1,48 +0,0 @@
-# All the following command work as well with multiple package names
-
-# To search for a package
-pacman -Ss <package name>
-
-# To update the local package base and upgrade all out of date packages
-pacman -Suy
-
-# To install a package
-pacman -S <package name>
-
-# To uninstall a package
-pacman -R <package name>
-
-# To uninstall a package and his depedencies, removing all new orphans
-pacman -Rcs <package name>
-
-# To get informations about a package
-pacman -Si <package name>
-
-# To install a package from builded package file (.tar.xz)
-pacman -U <file name/file url>
-
-# To list the commands provided by an installed package
-pacman -Ql <package name> | sed -n -e 's/.*\/bin\///p' | tail -n +2
-
-# To list explicitly installed packages
-pacman -Qe
-
-# To list orphan packages (installed as dependencies and not required anymore)
-pacman -Qdt
-
-
-# You can't directly install packages from the Arch User Database (AUR) with pacman.
-# You need yaourt to perform that. But considering yaourt itself is in the AUR, here is how to build a package from its tarball.
-# Installing a package from AUR is a relatively simple process:
-# - Retrieve the archive corresponding to your package from AUR website
-# - Extract the archive (preferably in a folder for this purpose)
-# - Run makepkg in the extracted directory. (makepkg-s allows you to install any dependencies automatically from deposits.)
-# - Install the package created using pacman
-# Assuming $pkgname contains the package name.
-wget "https://aur.archlinux.org/packages/${pkgname::2}/$pkgname/$pkgname.tar.gz"
-tar zxvf "$pkgname.tar.gz"
-cd "$pkgname"
-# Build the package
-makepkg -s
-# Install
-sudo pacman -U <package file (.pkg.tar.xz)>

cheat/cheatsheets/pdftk

@@ -1,9 +0,0 @@
-# Concatenate all pdf files into one:
-pdftk *.pdf cat output all.pdf
-
-# Concatenate specific pdf files into one:
-pdftk 1.pdf 2.pdf 3.pdf cat output 123.pdf
-
-# Concatenate pages 1 to 5 of first.pdf with page 3 of second.pdf
-pdftk A=fist.pdf B=second.pdf cat A1-5 B3 output new.pdf
-

cheat/cheatsheets/php

@@ -1,23 +0,0 @@
-# To view the php version:
-php -v
-
-# To view the installed php modules:
-php -m
-
-# To view phpinfo() information:
-php -i
-
-# To lint a php file:
-php -l file.php
-
-# To lint all php files within the cwd:
-find . -name "*.php" -print0 | xargs -0 -n1 -P8 php -l
-
-# To enter an interactive shell:
-php -a
-
-# To locate the system's php.ini files:
-php -i | grep "php.ini"
-
-# To start a local webserver for the cwd on port 3000 (requires php >= 5.4):
-php -S localhost:3000

cheat/cheatsheets/ps

@@ -1,15 +0,0 @@
-# To list every process on the system:
-ps aux
-
-# To list a process tree
-ps axjf
-
-# To list every process owned by foouser:
-ps -aufoouser
-
-# To list every process with a user-defined format:
-ps -eo pid,user,command
-
-# Exclude grep from your grepped output of ps.
-# Add [] to the first letter. Ex: sshd -> [s]shd
-ps aux | grep '[h]ttpd'

cheat/cheatsheets/python

@@ -1,16 +0,0 @@
-# Desc: Python is a high-level programming language.
-
-# Basic example of server with python
-# Will start a Web Server in the current directory on port 8000
-# go to http://127.0.0.1:8000
-
-# Python v2.7
-python -m SimpleHTTPServer
-# Python 3
-python -m http.server 8000
-
-# SMTP-Server for debugging, messages will be discarded, and printed on stdout.
-python -m smtpd -n -c DebuggingServer localhost:1025
-
-# Pretty print a json
-python -mjson.tool

cheat/cheatsheets/rm

@@ -1,5 +0,0 @@
-# Remove files and subdirs
-rm -rf path/to/the/target/
-
-# Ignore non existent files 
-rm -f path/to/the/target

cheat/cheatsheets/rsync

@@ -1,6 +0,0 @@
-# copy files from remote to local, maintaining file propertires and sym-links (-a), zipping for faster transfer (-z), verbose (-v).  
-rsync -avz host:file1 :file1 /dest/
-rsync -avz /source host:/dest
-
-# Copy files using checksum (-c), rather than time, to detect if the file has changed. (Useful for validating backups). 
-rsync -avc /source/ /dest/

cheat/cheatsheets/sam2p

@@ -1,2 +0,0 @@
-# Concatenate all pdf files into one:
-sam2p *.pdf out.pdf

cheat/cheatsheets/scp

@@ -1,5 +0,0 @@
-# To copy a file from your local machine to a remote server:
-scp foo.txt user@example.com:remote/dir
-
-# To copy a file from a remote server to your local machine:
-scp user@example.com:remote/dir/foo.txt local/dir

cheat/cheatsheets/screen

@@ -1,11 +0,0 @@
-# Start a new named screen session:
-screen -S session_name
-
-# Detach from the current session:
-Press Ctrl+A then press d
-
-# Re-attach a detached session:
-screen -r session_name
-
-# List all screen sessions:
-screen -ls

cheat/cheatsheets/sed

@@ -1,14 +0,0 @@
-# To replace all occurrences of "day" with "night" and write to stdout:
-sed 's/day/night/g' file.txt
-
-# To replace all occurrences of "day" with "night" within file.txt:
-sed -i 's/day/night/g' file.txt
-
-# To replace all occurrences of "day" with "night" on stdin:
-echo 'It is daytime' | sed 's/day/night/g'
-
-# To remove leading spaces
-sed -i -r 's/^\s+//g' file.txt
-
-# Remove empty lines and print results to stdout:
-sed '/^$/d' file.txt

cheat/cheatsheets/shred

@@ -1,13 +0,0 @@
-# To shred a file (5 passes) and verbose output:
-shred -n 5 -v file.txt
-
-# To shred a file (5 passes) and a final overwrite of zeroes:
-shred -n 5 -vz file.txt
-
-# To do the above, and then truncate and rm the file:
-shred -n 5 -vzu file.txt
-
-# To shred a partition:
-shred -n 5 -vz /dev/sda
-
-# Remember that shred may not behave as expected on journaled file systems if file data is being journaled.

cheat/cheatsheets/sockstat

@@ -1,2 +0,0 @@
-# To view which users/processes are listening to which ports:
-sudo sockstat -l

cheat/cheatsheets/sort

@@ -1,11 +0,0 @@
-# To sort a file:
-sort file
-
-# To sort a file by keeping only unique:
-sort -u file
-
-# To sort a file and reverse the result:
-sort -r file
-
-# To sort a file randomly:
-sort -R file

cheat/cheatsheets/split

@@ -1,8 +0,0 @@
-# To split a large text file into smaller files of 1000 lines each:
-split file.txt -l 1000
-
-# To split a large binary file into smaller files of 10M each:
-split file.txt -b 10M
-
-# To consolidate split files into a single file:
-cat x* > file.txt

cheat/cheatsheets/sqlmap

@@ -1,45 +0,0 @@
-# Test URL and POST data and return database banner (if possible)
-./sqlmap.py --url="<url>" --data="<post-data>" --banner
-
-# Parse request data and test | request data can be obtained with burp
-./sqlmap.py -r <request-file> <options>
-
-# Fingerprint | much more information than banner
-./sqlmap.py -r <request-file> --fingerprint
-
-# Get database username, name, and hostname
-./sqlmap.py -r <request-file> --current-user --current-db --hostname
-
-# Check if user is a database admin
-./sqlmap.py -r <request-file> --is-dba
-
-# Get database users and password hashes
-./sqlmap.py -r <request-file> --users --passwords
-
-# Enumerate databases
-./sqlmap.py -r <request-file> --dbs
-
-# List tables for one database
-./sqlmap.py -r <request-file> -D <db-name> --tables
-
-# Other database commands
-./sqlmap.py -r <request-file> -D <db-name> --columns
-                                           --schema
-                                           --count
-# Enumeration flags
-./sqlmap.py -r <request-file> -D <db-name>
-                              -T <tbl-name>
-                              -C <col-name>
-                              -U <user-name>
-
-# Extract data
-./sqlmap.py -r <request-file> -D <db-name> -T <tbl-name> -C <col-name> --dump
-
-# Execute SQL Query
-./sqlmap.py -r <request-file> --sql-query="<sql-query>"
-
-# Append/Prepend SQL Queries
-./sqlmap.py -r <request-file> --prefix="<sql-query>" --suffix="<sql-query>"
-
-# Get backdoor access to sql server | can give shell access
-./sqlmap.py -r <request-file> --os-shell

cheat/cheatsheets/ssh

@@ -1,23 +0,0 @@
-# To ssh via pem file (which normally needs 0600 permissions):
-ssh -i /path/to/file.pem user@example.com
-
-# To connect on an non-standard port:
-ssh -p 2222 user@example.com
-
-# To execute a command on a remote server:
-ssh -t user@example.com 'the-remote-command'
-
-# To tunnel an x session over SSH:
-ssh -X user@example.com
-
-# To launch a specific x application over SSH:
-ssh -X -t user@example.com 'chromium-browser'
-
-# To create a SOCKS proxy on localhost and port 9999
-ssh -D 9999 user@example.com
-
-# -X use an xsession, -C compress data, "-c blowfish" use the encryption blowfish
-ssh user@example.com -C -c blowfish -X
-
-# For more information, see:
-# http://unix.stackexchange.com/q/12755/44856

cheat/cheatsheets/ssh-copy-id

@@ -1,8 +0,0 @@
-# To copy a key to a remote host:
-ssh-copy-id username@host
-
-# To copy a key to a remote host on a non-standard port:
-ssh-copy-id username@host -p 2222
-
-# To copy a key to a remote host on a non-standard port with non-standard ssh key:
-ssh-copy-id ~/.ssh/otherkey "username@host -p 2222"

cheat/cheatsheets/ssh-keygen

@@ -1,14 +0,0 @@
-# To generate an SSH key:
-ssh-keygen -t rsa
-
-# To generate a 4096-bit SSH key:
-ssh-keygen -t rsa -b 4096
-
-# To update a passphrase on a key
-ssh-keygen -p -P old_passphrase -N new_passphrase -f /path/to/keyfile
-
-# To remove a passphrase on a key
-ssh-keygen -p -P old_passphrase -N '' -f /path/to/keyfile
-
-# To generate a 4096 bit RSA key with a passphase and comment containing the user and hostname
-ssh-keygen -t rsa -b 4096 -C "$USER@$HOSTNAME" -P passphrase

cheat/cheatsheets/stdout

@@ -1,5 +0,0 @@
-# To redirect stderr to stdout:
-some-command 2>&1
-
-# To redirect stderr to a file
-some-command 2> errors.txt

cheat/cheatsheets/strace

@@ -1,24 +0,0 @@
-# Basic stracing
-strace <command>
-
-# save the trace to a file
-strace -o strace.out <other switches> <command>
-
-# follow only the open() system call
-strace -e trace=open <command>
-
-# follow all the system calls which open a file
-strace -e trace=file <command>
-
-# follow all the system calls associated with process
-# management
-strace -e trace=process <command>
-
-# follow child processes as they are created
-strace -f <command>
-
-# count time, calls and errors for each system call
-strace -c <command>
-
-# trace a running process (multiple PIDs can be specified)
-strace -p <pid>

cheat/cheatsheets/systemctl

@@ -1,36 +0,0 @@
-# List all loaded/active units
-systemctl list-units
-
-# Check the status of a service
-systemctl status foo.service
-
-# Start a service
-systemctl start foo.service
-
-# Restart a service
-systemctl restart foo.service
-
-# Stop a service
-systemctl stop foo.service
-
-# Reload a service's configuration
-systemctl reload foo.service
-
-# Enable a service to startup on boot
-systemctl enable foo.service
-
-# Disable a service to startup on boot
-systemctl disable foo.service
-
-# List the dependencies of a service
-# when no service name is specified, lists the dependencies of default.target
-systemctl list-dependencies foo.service 
-
-# List currently loaded targets
-systemctl list-units --type=target
-
-# Change current target
-systemctl isolate foo.target
-
-# Change default target
-systemctl enable foo.target