Code Monkey home page Code Monkey logo

allcommands's Introduction

Contributors ✨

Thanks goes to these wonderful people, we will upload your picture once you make your contribution


Esther


Kevin


Nithin


Peiyan


Dhananshan

allcommands.io

allcommands.io is a portal for developers who use commands frequently in their day to day life or once in a while usage. We all forget syntax and need quick reference rather than going through the offical pages.

  • This repo contains json file for each framework, tool, etc. which requires contribution
  • The repo for allcommands.io portal is here. Feel free to contribute there as well

Setup

This repo contains .json files for each framework/ tool (e.g. dotnet.json, docker.json, etc). Each of these .json files contains respective commands added by valuable contributer like you. There is another repo for the web application allcommands.io which is here. The web app will read each of these .json files and display. Its simple as it is.

How To Contribute

Its extremely simple to contribute. The follwing 3 steps is all needed to contribute. Each steps are explained with pictures.

  • If you are already familiar with git then you know the drill. -> fork -> create a new branch from master -> add/ edit your changes -> push the branch -> create a pull request

  • For those who are new, follow the below 2 option to contribute directly via github portal.

Option1: If you want to add commands to an existing file

  1. Go to allcommands repositary

  2. Click on the file you want to edit (e.g. dotnet.json)

  3. Click on edit icon edit

  4. Make your changes then add your comment and click on Propose file change edit change

  5. Then click on Create pull request button edit pr

  6. Now you will be in Open a pull request page, leave any comments if necessary and click on Create pull request edit create pr

Option2: If you want to add commands to a framework/ tool which does not have an existing file

  1. Go to allcommands repositary

  2. Click on Create new file add

  3. Add a filename (e.g. powershell.json), add your commands, comment and click on Propose new file add changes

  4. Then click on Create pull request button add pr

  5. Now you will be in Open a pull request page, leave any comments if necessary and click on Create pull request add create pr

That's all needed to contribute. One of the reviewers will merge it into the master and the commands will be visible in allcommands.io portal which will be used by many developers.

JSON format

{
   "category":"powershell",
      "release":{
         "version":"1.0",
         "commands":[
            {
               "command":"Test-Path",
               "description":"Test-Path lets you verify whether items exist in a specified path",
               "usage":"Test-Path <FILE PATH>"
            },
            {
               "command":"Start-Sleep",
               "description":"To suspend the activity in a script or session",
               "usage":"Start-Sleep -Seconds <Seconds>",
               "options":[
                  {
                     "value":"Seconds",
                     "description":"sleep in seconds",
                     "usage":"Start-Sleep -Seconds <Seconds>"
                  },
                  {
                     "value":"Milliseconds ",
                     "description":"sleep in milliseconds",
                     "usage":"Start-Sleep -Milliseconds <Milliseconds>"
                  }
               ]
            }   
       ]
      }
}

JSON format Explained

Key Description
category The framework or tool (should be same as file name excl .json)
release
version Version number of document (retain it when updating or default to 1.0 when adding new)
commands
command Command name eg. git pull
description Describe what the command does
usage Example of the command usage
options Array of options that come with the commands
value The value of option eg. git pull origin master. Just have to put origin [branch name]
description Describe what the option does
usage Example of the command with option

TODO

  • Login feature
  • bookmark frequently used commands

Feedback

allcommands.io is for developers by developers. Please feel free to raise issue in github or feel free to contact us via [email protected]

allcommands's People

Contributors

allcommands avatar dhananshan avatar m3yevn avatar tlnithin avatar xiaoai0109 avatar xxeasterxx avatar

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.