desktoptips / ahkpm

The AutoHotKey Package Manager

ahkpm - The AutoHotKey Package Manager.

AutoHotKey is a powerful tool for scripting automations on Windows, but managing dependencies for your scripts is painful. ahkpm intends to bring modern package management to AutoHotkey, making it easier than ever to automate away the drudgery.

Commands

Usage:
  ahkpm [command]

Available Commands:
  cache clean  Clears the package cache
  completion   Generate the autocompletion script for the specified shell
  help         Help about any command
  init         Interactively create an ahkpm.json file in the current directory
  install      Installs either the specified package or all packages listed in ahkpm.json

Flags:
  -h, --help   help for ahkpm

Installation

At this point you will need to compile ahkpm on your machine and then add it to your path. Future versions will include an installer.

Basic usage

1. Open the command line and navigate to the directory which will contain your AutoHotKey script.
2. Run ahkpm init and answer the prompts to create an ahkpm.json file
3. Run ahkpm install <package>@<version>
   • The package can be any github repository in the form: github.com/user/repo
   • The version can be any of the following:
     • A valid semantic version such as 1.0.0
     • The prefix tag: followed by the name of a tag in the package's repository, such as tag:beta2
     • The prefix branch: followed by the name of a branch in the package's repository, such as branch:main
     • The prefix commit: followed by the hash of a commit in the package's repository, such as commit:badcce14f8e828cda4d8ac404a12448700de1441
     • Omitting the version is not yet supported
4. Add #Include, %A_ScriptDir% to the top of your script to set the current directory as the context for subsequent includes
5. Add #Include, ahkpm-modules\github.com\user\repo\main-file.ahk to your script
6. You can now use the package's functionality within your AutoHotKey script!

ahkpm.json

{
  "name": "my-project",
  "version": "0.0.1",
  "description": "A brief description of what the package does",
  // URL for the package's git repository
  "repository": "github.com/user/my-project",
  // URL for the package's main website
  "website": "example.com",
  // The SPDX License identifier for the package's software license
  "license": "MIT",
  // URL for users to file bugs/issues for the package
  "issueTracker": "github.com/user/my-project/issues",
  // Information about the primary author of the package
  "author": {
    "name": "joshuacc",
    "email": "",
    "website": "joshuaclanton.dev"
  },
  // Lists all dependencies along with the required version
  "dependencies": {
    "github.com/user/repo1": "1.0.0",
    "github.com/user/repo2": "tag:beta2",
    "github.com/user/repo3": "branch:main",
    "github.com/user/repo4": "commit:badcce14f8e828cda4d8ac404a12448700de1441"
  }
}