DocDigitizer PowerShell Module

Installation Guide

Requirements

  • Windows PowerShell 5.1 or PowerShell 7+
  • Internet connection
  • Git (we’ll show you how to install it if needed)

Installation Steps

Step 1: Open PowerShell

Press Windows + X and select Windows PowerShell or Terminal.

Alternatively, search for “PowerShell” in the Start menu.

Step 2: Check if Git is installed

Type this command and press Enter:

git --version

If you see a version number (like “git version 2.x.x”), Git is installed. Skip to Step 3.

If you see an error, you need to install Git:

  1. Go to https://git-scm.com/download/win
  2. Download and run the installer
  3. Use all default options during installation
  4. Close and reopen PowerShell
  5. Try git --version again to confirm it works

Step 3: Choose where to install

Navigate to a folder where you want to keep the module. For example:

cd C:\Tools

If the folder doesn’t exist, create it first:

mkdir C:\Tools
cd C:\Tools

Step 4: Download the module

Run this command to download the module:

git clone https://github.com/DocDigitizer/dd-cmdlets.git

This creates a folder called dd-cmdlets with all the module files.

Step 5: Get your API key

To use the DocDigitizer API, you need an API key. Request one at:

https://docdigitizer.com/contact

Step 6: Import the module

Load the module into PowerShell:

Import-Module .\dd-cmdlets\DocDigitizer.psd1

You should see this message:

[DocDigitizer] Module loaded - 5 commands available

Step 7: Set your API key

Configure your API key:

Set-DocDigitizerConfig -ApiKey "your-api-key-here"

To save it permanently (so you don’t have to set it every time):

Set-DocDigitizerConfig -ApiKey "your-api-key-here" -Persist

Step 8: Test the connection

Verify everything is working:

Test-DocDigitizerConnection

You should see:

Url       : https://apix.docdigitizer.com/sync
Connected : True
Response  : I am alive
Latency   : ...

Done!

You’re ready to process documents. Try this:

Send-DocDigitizerDocument -FilePath "C:\path\to\your\document.pdf"

Using the Module in Future Sessions

If you used -Persist when setting your API key, it will be saved automatically.

Otherwise, each time you open PowerShell, import the module and set your key:

Import-Module C:\Tools\dd-cmdlets\DocDigitizer.psd1
Set-DocDigitizerConfig -ApiKey "your-api-key-here"

Updating the Module

To get the latest version:

cd C:\Tools\dd-cmdlets
git pull

Alternative: Download as ZIP

If you can’t use Git, you can download the module as a ZIP file:

  1. Go to https://github.com/DocDigitizer/dd-cmdlets
  2. Click the green Code button
  3. Click Download ZIP
  4. Extract the ZIP to a folder (e.g., C:\Tools\dd-cmdlets)
  5. Import the module: 
    Import-Module C:\Tools\dd-cmdlets\DocDigitizer.psd1

Troubleshooting

“git” is not recognized

Git is not installed. Follow Step 2 above to install it.

“The file cannot be loaded because running scripts is disabled”

Run this command to allow scripts:

Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser

Then try importing the module again.

“Could not find module”

Make sure you’re in the correct folder. Check with:

Get-Location
Get-ChildItem

You should see the dd-cmdlets folder listed.

Connection test fails

Check your internet connection and firewall settings. The module needs to reach https://apix.docdigitizer.com.