Thanks goes to these wonderful people, we will upload your picture once you make your contribution
Esther |
Kevin |
Nithin |
Peiyan |
Dhananshan |
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
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.
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.
-
Go to allcommands repositary
-
Click on the file you want to edit (e.g. dotnet.json)
-
Make your changes then add your comment and click on
Propose file change
-
Now you will be in
Open a pull request page
, leave any comments if necessary and click onCreate pull request
-
Go to allcommands repositary
-
Add a filename (e.g. powershell.json), add your commands, comment and click on
Propose new file
-
Now you will be in
Open a pull request page
, leave any comments if necessary and click onCreate pull request
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.
{
"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>"
}
]
}
]
}
}
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 |
- Login feature
- bookmark frequently used commands
allcommands.io is for developers by developers. Please feel free to raise issue in github or feel free to contact us via [email protected]