Git Product home page Git Product logo

cheat.sheets's Introduction

cheat.sheets

Own cheat sheets repository of the cheat.sh.

If you want to add a cheat sheet to cheat.sh directly, add it here (please also consider adding your cheat sheet to one of the upstream repositories).

When adding a cheat sheet please use the following format:

# Command name
# Short command description

# Command usage example1 started with some comments
# and followed with a command example/switches.
command1

# Command usage example2.
# Each block separated with an empty line.
command2

For example:

# curl
# Command-line tool for transferring data with URL syntax

# Process a single GET request, and show its output on stdout.
curl http://path.to.the/file

Requirements and constraints:

  • Maximum length of a comment line (including comment sign) is 80

Other requirements can be proposed and discussed in #101

Getting started

If you are new to Github, and you want to contribute to cheat.sheets, you can start from this video:

cheat.sheets's People

Contributors

abbbi avatar abitrolly avatar alexberry avatar angoca avatar bvdeenen avatar cepoole avatar chubin avatar datbayev avatar dayne avatar dufferzafar avatar hornjbl avatar iandstanley avatar isabekov avatar lepatrick714 avatar lucis-fluxum avatar mftabriz avatar mritzmann avatar neilhwatson avatar nondv avatar olivech12 avatar qvieth avatar raymondchen625 avatar sne4ky avatar soptikha2 avatar sullivant avatar terminalforlife avatar trangoul avatar vjanssens avatar webdragon avatar wizardofaus avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

cheat.sheets's Issues

bash strings

There should be way more examples for bash string usage:

${foo:2}
${foo%…}
${foo#…}
${foo##…}

etc.

Add i3 cheatsheet

What about adding i3 cheatsheet? I can write it and send pull request if you want to.

jq cheat sheet

Create a new cheat sheet, for the jq command.

Besides the main purpose of the cheat sheet, coverage of the jq command,
it could be a test bed for such fearures:

  • Big sectioned cheat sheet
  • support for example output for commands.

Awk issue

I'm not sure why but the formatting of curl cht.sh/awk seems to return the json payload

> curl https://cht.sh/awk
{"topic": "awk", "answer": "# sum integers from a file or stdin, one integer per line:\nprintf '1\\n2\\n3\\n' | awk '{ sum += $1} END {print sum}'\n\n# using specific character as separator to sum integers from a file or stdin\nprintf '1:2:3' | awk -F \":\" '{print $1+$2+$3}'\n\n# print a multiplication table\nseq 9 | sed 'H;g' | awk -v RS='' '{for(i=1;i<=NF;i++)printf(\"%dx%d=%d%s\", i, NR, i*NR, i==NR?\"\\n\":\"\\t\")}'\n\n# Specify output separator character\nprintf '1 2 3' | awk 'BEGIN {OFS=\":\"}; {print $1,$2,$3}'\n\n# search for a paragraph containing string\nawk -v RS='' '/42B/' file\n", "topic_type": "cheat.sheets", "format": "code"}

When I would expect a more readable format like so:

> curl https://cht.sh/ls
# 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

# Display directories only
ls -d */

# Display directories only, include hidden
ls -d .*/ */

[emacs] too much info?

Do people really need a section about telnet in the cheatsheet?

Or, maybe, we could just split them into different files:

  • emacs/telnet
  • emacs/dired

I feel like the main page should be as short as possible and contain only essential info and refer other pages.

Cheat sheet standardized formatting

Hi @chubin !

I don't recall seeing a method by which I or another can contact you -- might be nice to set up an E-Mail for that, for these awesome projects of yours, if you haven't already done so. It would save creating issues like this.

Okay, so my question, regarding the formatting of the sheets, is whether this is preferred:

# CMD
# Short description

...

Or this, apt-cache(1) search style:

# CMD - Short description

...

Or this:

# CMD
#
# Short description

...

Reason being, my OCD screams at me when I see inconsistencies (lol), and I was hoping to, if you'd like, go through each of the cheets to make it either one of those styles, or perhaps another of your choosing.

What think you?

Handle cheat sheets existing in several upstream repositories

Todo

  • all cheat sheets from all upstream repositories must be shown by default
  • there are must be a way do address a cheat sheet from some repository directly (say: cheat:cpdf).

Details

Previously, I would just add cheat sheets to https://github.com/cheat/cheatsheets

But now, I'm a bit confused.

Say, I want to add a new jq sheet. There's one in this repo: https://github.com/chubin/cheat.sheets/blob/master/sheets/jq and this is the one that is served when querying cht.sh jq

Then there's this one https://github.com/cheat/cheatsheets/blob/master/jq

Which of the two should I update so that most people benefit from the change?

If the answer is both, can something be done about this?

/cc @chrisallenlane

Recommend Projects

  • React photo React

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

  • Vue.js photo Vue.js

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

  • Typescript photo Typescript

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

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

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

  • web

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

  • server

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

  • Machine learning

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

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

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

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.