PowerShell has been the go-to solution for Windows SysAdmins for years now, enabling us to do automation and scripting. With PowerShell now being Open Source and cross-platform we are not only seeing a growing adoption from Mac and Linux users, but the language is making its way through CI/CD tools as well. With the PowerShell module civoShell you can manage Civo through PowerShell and create scripts, as soon as you install the module of course.
Note: This is a work in progress. There might be a limited number of cmdlets (PowerShell commands) available when you install but this changes daily. If you have any feature requests, or experience bugs, feel free to add an issue at GitHub.
Installation
The module is published through the PowerShell Gallery, which makes it easy to install and keep up to date. To install, just simply run:
Install-Module -Name civoShell
If you are working on a machine with less privileges, you can install the module only for you by running:
Install-Module -Name civoshell -Scope CurrentUser
Tip: When you have installed the module, you can update the module by running the Update-Module cmdlet.
Usage
You can import the module and see what cmdlets are available by running the following:
Import-Module civoShell
Get-Command -Module civoShell
Now that we have our cmdlets, we need to set up our API key. You can find your key at civo.com/api. The PowerShell module uses a environment variable to store the API key, which you can set by running the follow cmdlet:
Set-CivoApiToken >YourApiKeyHere<
If you need to set a new API key, you can use the switch -Force
to overwrite it.
From here on, it's up to you. There are so many things you can do with PowerShell that listing them all is impossible, but I will make sure to update the Learn section with relevant information about the module and how to use it.