PowerShell/README.md

84 lines
4.6 KiB
Markdown
Raw Normal View History

2020-06-19 18:00:03 +02:00
Collection of Useful PowerShell Scripts (CUPS)
==============================================
2020-05-01 11:44:56 +02:00
2020-04-30 17:59:12 +02:00
Useful cross-platform PowerShell scripts, to be used on the command-line (CLI) or by automation software like Jenkins.
2020-05-01 11:44:56 +02:00
2020-09-25 14:50:28 +02:00
PowerShell Scripts Included
---------------------------
2020-09-29 20:35:44 +02:00
* [download.ps1](Scripts/download.ps1) - downloads the file/directory from the given URL
2020-09-25 14:54:33 +02:00
* [exe_info.ps1](Scripts/exe_info.ps1) - prints basic information of the given executable file
2020-09-25 15:03:48 +02:00
* [lscmdlets.ps1](Scripts/lscmdlets.ps1) - lists all PowerShell cmdlets
* [lsmods.ps1](Scripts/lsmods.ps1) - lists all PowerShell modules
* [lsproc.ps1](Scripts/lsproc.ps1) - lists the local computer processes
* [MD5.ps1](Scripts/MD5.ps1) - prints the MD5 checksum of the given file
2020-10-02 09:29:24 +02:00
* [make-install.ps1](Scripts/make-install.ps1) - installs built executables and libs to the installation directory
2020-09-25 15:03:48 +02:00
* [moon.ps1](Scripts/moon.ps1) - prints the current moon phase
* [password.ps1](Scripts/password.ps1) - generates and prints a single new password
* [passwords.ps1](Scripts/passwords.ps1) - generates and prints a list of new passwords
* [poweroff.ps1](Scripts/poweroff.ps1) - halts the local computer, administrator rights might be needed
* [news.ps1](Scripts/news.ps1) - prints the latest news
* [reboot.ps1](Scripts/reboot.ps1) - reboots the local computer, administrator rights might be needed
* [screenshot.ps1](Scripts/screenshot.ps1) - takes a single screenshot
* [screenshots.ps1](Scripts/screenshots.ps1) - takes multiple screenshots
2020-09-25 15:03:48 +02:00
* [SHA1.ps1](Scripts/SHA1.ps1) - prints the SHA1 checksum of the given file
* [SHA256.ps1](Scripts/SHA256.ps1) - prints the SHA256 checksum of the given file
* [speak.ps1](Scripts/speak.ps1) - speaks the given text by text-to-speech (TTS)
* [test.ps1](Scripts/test.ps1) - simple test script
* [train_dns_cache.ps1](Scripts/train_dns_cache.ps1) - trains the DNS cache with frequently used domain names
* [translate.ps1](Scripts/translate.ps1) - translates the given text
* [txt2wav.ps1](Scripts/txt2wav.ps1) - converts text into a audio .WAV file
2020-09-30 15:25:52 +02:00
* [validate_xml.ps1](Scripts/validate_xml.ps1) - validates the given XML file
2020-09-25 15:03:48 +02:00
* [weather.ps1](Scripts/weather.ps1) - prints the current weather forecast
* [wakeup.ps1](Scripts/wakeup.ps1) - sends a magic packet to the given computer, waking him up
* [zipdir.ps1](Scripts/zipdir.ps1) - creates a zip archive of the given folder
2020-05-22 09:54:16 +02:00
2020-08-11 13:48:27 +02:00
What is PowerShell?
-------------------
2020-06-15 16:01:12 +02:00
2020-05-04 14:39:06 +02:00
PowerShell is a task automation and configuration management framework from Microsoft, consisting of a command-line shell and associated scripting language.
2020-08-11 14:15:02 +02:00
* it's **cross-platform**: available for Linux, Mac OS and Windows
2020-08-11 13:51:30 +02:00
* it's **powerful**: fully control your computer
* it's **open-source**: see the Github repository at https://github.com/PowerShell/PowerShell
* it's **easy to learn**: see the tutorial at https://www.guru99.com/powershell-tutorial.html
* it's **fully documented**: see the official docs at https://docs.microsoft.com/en-us/powershell/
2020-05-01 11:44:56 +02:00
2020-08-11 13:48:27 +02:00
How to get PowerShell?
----------------------
2020-08-11 14:11:48 +02:00
Windows 7 and newer do provide PowerShell by default. It's recommended to use it via **Windows Terminal** (see the Microsoft Store at https://www.aka.ms/terminal).
For installation on alternative platforms (CentOS, Debian, Docker, Fedora, macOS, openSUSE, Red Hat, Ubuntu) visit https://github.com/PowerShell/PowerShell.
2020-08-11 13:48:27 +02:00
2020-08-11 14:29:29 +02:00
Afterward, install the scripts by clicking on the green "Code" button or execute:
2020-08-11 14:27:11 +02:00
```
$ git clone https://github.com/fleschutz/PowerShell
```
2020-08-11 13:48:27 +02:00
How to configure PowerShell as default shell on Linux?
------------------------------------------------------
2020-06-15 16:01:12 +02:00
2020-06-15 16:42:52 +02:00
Make sure PowerShell is installed, then use the `chsh` commmand as follows:
* `chsh -s /bin/powershell <username>`
2020-06-15 15:56:18 +02:00
2020-08-11 14:11:48 +02:00
2020-08-11 13:48:27 +02:00
How to add the subfolder Scripts/ to the search path for command-line usage?
----------------------------------------------------------------------------
2020-06-15 16:01:12 +02:00
2020-05-25 20:55:16 +02:00
* **Windows:** open the environment variables dialogue and add the full path to Scripts/ to the system environment variable "Path"
* **Bash or sh:** edit .profile in your home directory and add the line: PATH="$PATH:/path/to/PowerShell/Scripts"
2020-05-25 20:37:47 +02:00
2020-05-01 12:09:03 +02:00
Script Standards
----------------
2020-09-30 15:52:51 +02:00
Each script supports the following:
1. **a metadata header** containing the syntax, description, author, source, and license
2. **prefers command-line options** but may ask the user in case no option is given
3. **encoding in UTF-8 with BOM** to support Unicode characters
4. **exits 0 for success**, otherwise the error code (mostly 1)
2020-05-02 13:01:03 +02:00
2020-06-15 15:09:54 +02:00
Feedback
--------
2020-06-15 16:01:12 +02:00
Send your email feedback to: markus [at] fleschutz [dot] de
2020-06-15 15:09:54 +02:00
2020-05-02 13:01:03 +02:00
License & Copyright
-------------------
This open source release is licensed under the CC0 license. All trademarks are the property of their respective owners.