michaeljolley / devtoolbox Goto Github PK

View Code? Open in Web Editor NEW

43.0 5.0 12.0 2.43 MB

A PowerShell module that enables software developers to speed up their CLI workflow.

License: MIT License

PowerShell 100.00%

powershell alias powershell-scripts hacktoberfest

devtoolbox's Introduction

What & Why

For more information as to how this repo came about, check out this blog post

Installation

The easiest way to install devtoolbox is via the PowerShell Gallery.

Install-Module -Name devtoolbox

Parameters

All aliases accept parameters of the commands they call.

For example, the below are identical:

g cl https://github.com/michaeljolley/devtoolbox.git

git clone https://github.com/michaeljolley/devtoolbox.git

Commands

Docker

All aliases for Docker begin with d.

Command	Executes
d b	docker build
d c	docker container ps
d cr	docker container rm
d cs	docker container start
d cx	docker container stop
d i	docker image ls
d ir	docker image rm
d k	docker kill
d l	docker logs
d li	docker login
d lo	docker logout
d r	docker run
d t	docker image tag
d p	docker push
d ...	docker ...(any parameters)

Docker-Compose

All aliases for Docker Compose begin with dc.

Command	Executes
dc b	docker-compose build
dc bu	docker-compose build (params); docker-compose up
dc d	docker-compose down
dc i	docker-compose images
dc u	docker-compose up
dc ...	docker-compose ... (any parameters)

Git

All aliases for Git begin with g.

Command	Executes
g a	git add
g b	git branch
g c	git checkout
g cl	git clone
g co	git commit
g f	git fetch
g i	git init
g l	git log
g ll	git log --graph (pretty)
g m	git merge
g pl	git pull
g ps	git push
g r	git rebase
g rs	git reset
g s	git status
g t	git tag
g ...	git ... (any parameters)

Miscellaneous

Command	Executes
github	Launches browser to GitHub repo if the directory is tracked by Git and its origin url is at GitHub
hosts	If in Windows, opens the hosts file in an elevated editor. Choosing, in order, between VS Code, VS Code (insiders), Notepad.
rwp	Restores NPM, Nuget, and Libman packages starting at the root folder of a workspace.
Syntax	Prints PowerShell Command Syntax vertically, replicating docs.microsoft.com layout
Sort-Reverse	Reverses the order of an array. Accepts pipeline support e.g. `1,2,3,4,5

Contributing

Want to contribute? Check out our Code of Conduct and Contributing docs. Contributions of any kind welcome!

devtoolbox's People

Contributors

Stargazers

Watchers

Forkers

ryannosaurusrex parithon brettmillerb millidevx radinsinisa ctmcisco cmjchrisjones ohsevin digitaldrummerj digitaldrummerj-chocolatey pabloaugusto eplord

devtoolbox's Issues

Add Git Diff command

It would be great to add a git diff command. Maybe 'g d' for the command.

Does not load on PowerShell Core

Renamed file to psm1 in an attempt at a start for #12 when trying to import into PowerShell Core, get errors regarding the Get-WmiObject calls as these cmdlets are not available in PowerShell Core. An alternative would be the cim cmdlets, but IIRC that's not cross platform as the cim cmdlets don't exist on -not $IsWindows. A more robust alternative may be to use Get-Process as IIRC it exists across the board.

Reload command now requires approval and opens new shell

Before converting to a module the reload would happen in place. I believe this is due to the commented out code in the HelperFunctions.psm1 file. We need to uncomment that code and get it working again.

I believe @brettmillerb is the one who initially added it so he may know the best way to implement it now that we're using a module.

Pass through "unknown" commands?

Just putting this somewhere to capture the thought...

The Git and Docker functions only handle their known aliases, would be a good idea I think to pass unknown commands on to their respective commands. So for instance if someone wanted they could do g log and it would be translated to git log. This allows the user to continue using git for commands that we may not have aliased.