Basic command line helper utilities for software developers.
The intended usage for CommandLineHelper is to provide a more linux like command line experience. Eventually I hope to provide most of the linux utilitie. It's useful, but can also be a great way to learn batch scripting. This is mostly a proof of concept project where I am trying to unlock the command line for windows and make it more powerful for windows. I've written thousands of scripts and I'm trying to find a way to categorize these into features that others might find useful. Scripts are written in ruby, powershell,python and vb and do a variety of administrative tasks.
Start by downloading the repo. Run the Start.bat to begin. Start.bat --help will display the command line options.
i.e.
start.bat --Install
Result: Will prompt the user for information needed before creating an alias.cmd. If the directories are missing they will be automatically generated. An alias.cmd link location will be associated with the HKCU\Software\Microsoft\Command Processor AutoRun REG_SZ key. This will cause the alias.cmd to be loaded every time a new command window is crated. You can manually edit the alias.cmd file anytime.
The power of having an alias.cmd is that you can specify aliases that apply to future command window sessions rather than having to reset variables all the time. Lets say you hate to type cd c:\dev. Using a doskey command like the one below will make it so every time you type "dev" the CD /D C:\Dev command will run. i.e. DOSKEY dev=CD /D c:\dev It's very powerfull to use aliases in your command window and having them in the alias.cmd will make sure that all your favorite shortcuts are available every time you open a command window.
The start.bat file will be used to install any the clhelper command further enhances your automated command structure without the need to install anything. It's the basis of any good relationship with windows.
The READWRITEINI function will read and write to ini files within batches for configuration purposes. When reading something from an INI file specify the key and a temporary environment variable name you would like to set as the output. If you were to type: ECHO %variable% your command window will display the value of the key you specified.
Example: INIFile Structure:
[section]
key=value
READWRITEINI "Section" "key" "variable" ECHO %variable%
results in value
These settings don't stop working just because you open another command window. Once CommandLineHelper is installed you can edit them and continue improve upon them. Please contribute to the CommandLineHelper either your suggestions or add your own changes to the source repository here.
"FindString YourRegularExpression Text"
"desktop" Changes directory to your desktop "%userprofile%\Desktop directory.
"dev" Changes directory to your dev directory.
"Download" Changes directory to your "%USERPROFILE%\Downloads" directory.
"pictures" Changes directory to your "%USERPROFILE%\Pictures" directory.
"videos" Changes directory to your "%USERPROFILE%\Videos" directory.
"OneDrive" Changes directory to your "%USERPROFILE%\onedrive" directory.
"Documents" Changes directory to your "%USERPROFILE%\Documents"
"iCloudDrive" Changes directory to your "%USERPROFILE%\iCloudDrive"
"Searches" Changes directory to your "%USERPROFILE%\Searches"
"clh" Runs "c:\CommandLineHelper\Scripts\CLHelper.bat $*"
"logout" Logs off the machine from the command line. Runs Shutdown -l
"logoff" Logs off the machine from the command line. Shutdown -l
"restart" Restarts the computer from the command line. Shutdown -g -t 30 -f
"forceoff" Forces all users off the machine from the command line. Shutdown /p
"shutoff" Shuts off the machine from the command line. Shutdown -s -t 30
"Hibernate" Puts the computer in hibernation mode from the command line. Shutdown -h
"rshutdown" Displays the graphical user interface (GUI) for Shutdown. shutdown -i
"abort" Aborts a shutdown. Shutdown -a
"lock" Locks the workstation similar to {WinKEY + L}. rundll32.exe user32.dll, LockWorkStation
"word" Opens Microsoft Word from the command line.
"mspub" Opens Microsoft Publisher.
"outlook" Opens Microsoft Outlook.
"ppt" Opens Microsoft PowerPoint
"excel" Opens Microsoft Excel
"xls" Opens Microsoft Excel
"xlsx" Opens Microsoft Excel
"np" Opens notepad++.exe and supports np filename options for quick editing.
"GitForce" Cleans and removes all changes in git repo and pulls latest code.
"GitCommit" Pulls latest code and prompts for commit message before committing changes.
"HGCommit" Pulls latest code and prompts for commit message before committing changes.
"explorer" Opens Windows Explorer to current location.
"CLCopy" Copies a file and prompts user for overwrite while creating directories
in the destination if they do not exist.
"rc" Random color for command window background and text. You can also specify
a color like "rc lightblue black".
"commit" Same as "GitCommit", pulls latest code and prompts for commit message
before commiting changes.
"custom" Loads your own custom alias settings.
"ls" Linux list command i.e. ls
"vjson" Verifies a json file (requires ruby)
"rdp" Starts a remote desktop connection automatically passing in your username and credentials
as well as adding the fully qualified computer name.
Example:
"rdp computername" will open a remote desktop connection and automatically log in even
if you have never done so.
"rdp computername1,computername2" will open a remote desktop connection automatically
and automatically log in even if you have never done so.
"rdp" by it self will use the "[RemoteConnections]" section and key
"WindowsServers=computername,computername1,computername2" found in the
CommandLineHelper\scripts\clhelper.ini file.
e.g. if you're clhelper.ini file had the following settings an RDP session would start
for each computer in the list.
Example 'clhelper.ini':
[RemoteConnections]
WindowsServers=computername,computername1,computername2
This feature also requires the following settings in your clhelper.ini file.
[<Your Local PC User Account Name Here>]
MyPassword=<Your Domain Password Here>
MyUserName=<Your Domain User Name Here>
MyDomainOrWorkgroup=<Your Local Domain Name>.<Public Domain Extension i.e. '.com'>
"window" Changes the window size.
Example:
"window long" makes your command window long i.e. 9999 lines.
"window short" makes your command window shorter i.e. 40 lines.
"Window short fat" makes your command window shorter i.e. 40 lines but wider i.e. 150.
"Window short" without 'fat' will change the command window back to 120 characters.
"linux" Will open an ssh connection with a linux machine. Currently, this feature only works with
linux servers. It's similar to an RDP session window above but for linux. This feature
does require that you have run the ssh remote key setup - an automated feature is coming
that will automatically create the keys.
Example:
"linux computername" opens an ssh connection to that computer.
Example 'clhelper.ini':
[RemoteConnections]
LinuxServers=LinuxComputername,LinuxComputername1,LinuxComputerName2
"sshi" Easiest way to connect to a linux machine.
Example: Easy, to login.
sshi <Linux Machine Name>
Configuration:
CLHelper.bat --SetupSSH linuxmachine1,linuxmachine2,linuxmachine3... etc.
"plink" PuTTy command-line utility plink.exe
"pscp" PuTTy command-line utility pscp.exe
"psftp" PuTTy command-line utility psftp.exe
"putty" PuTTy command-line utility putty.exe
"ip" Shows the active IP addresses. Shorter and nicer than typing ipconfig.
"simpleDownload" Downloads file from internet.
"iexplore=" Starts Internet Explorer
"ie" Starts Internet Explorer
"firefox" Starts Firefox
"KILL" Kills a task by name.
"clh-install" Shortcut for CommandLineHelper from source dir without prompts. "setup.bat --Install Y"
Open a command window and change to the directory where you downloaded the CommandLineHelper source. Run:
Unpack the source folder to c:\CommandLineHelper Open the command prompt and run the following commands:
REG ADD "HKCU\Software\Microsoft\Command Processor" /v AutoRun /t REG_SZ /d C:\CommandLineHelper\Scripts\cmd\alias.cmd /f
REG ADD "HKCU\Software\Microsoft\Command Processor" /v CommandLineHelper /t REG_SZ /d C:\CommandLineHelper /f
c:\CommandLineHelper\Scripts\alias.cmd
clhelper.bat --SetupUserIniSettings
setup.bat --Alias-Remove
NOTE: This essentially only removes the registry key. All files will remain untouched. You can run --install to re-install the registry key.
After the setup is complete you can edit the \CommandLineHelper\scripts\clhelper.ini to customize and automate features.
[Local]
CLHelper_Dir=c:\CommandLineHelper
[Mike]
MyPassword=MyUniquePassword
MyUserName=Mike
MY_Scripts_Dir=c:\dev\scripts
My_Dev_Env_Dir=c:\dev
MyDomainOrWorkgroup=BobsDomain.dom
LastName=Mike
FirstName=Boxer
[RemoteConnections]
TargetServers=
WindowsServers=winserver1,winserver2
LinuxServers=linserver1,linserver2
https://github.com/GaryLBaird/CommandLineHelper/blob/master/scripts/cmd/libs/clhHelp.cmd
You can only run CommandLineHelper from an command window with "Run as administrator" privilidges enabled. I recommend that you create a shortcut and set the runas feature to run as administrator every time you open a new command window. You really only need the administrator privilidges if you are not actually going to be running clhelper.bat functions, but it's nice if you don't have to re open another window.
If you attempt to run clhelper.bat without administrator privilidges you will see the following message:
Administrative permissions required. Detecting permissions...
Failed: Please start a new command window with administrative permissions.
Press Enter Continue:
If you attempt to run clhelper.bat administrator privilidges you will see the following message the first time it runs:
Administrative permissions required. Detecting permissions...
Success: Administrative permissions confirmed.
Username and password can be stored and retrieved from an ini file and accessed via the command line.
NOTE: This stores a clear text password in a local ini file.
- Installer Section: for performing installs where files are downloaded from the internet and installed.
- Customization: Customizations are not currently stored in the ini file. One should be generated if it is missing and when questions are answered you should put them in the ini so that they are found in the future.
- Curl Support:
- Support Curl directly and conversion to ruby
- Ruby Gem: Support
- PowerShell: Support for standard tasks using PowerShell.
- PowerShell: Launcher*: that enables and disables security automaticall while running script.
GaryLBaird