Skip to content
This repository has been archived by the owner on Sep 26, 2020. It is now read-only.

Aliases

Greg R edited this page Apr 24, 2020 · 2 revisions

Aliases let user define custom "shortcuts" for Forge commands, adding possibility of making Forge working better with personal workflows.

File Format

Aliases are defined using TOML file:

[alias]
    test='fake RunTests'
    build-test='fake BuildTest'

Keys defines new command, values define what will be executed (so for above example calling forge test will result in running forge fake RunTests.

Default aliases

Here is set of default aliases used built into Forge:

[alias]
    build='fake'
    test='fake Test'
    release='fake Release'
    install='paket install'
    update='paket update'

Alias definition.

Aliases can be defined in 2 places:

  1. Global installation - you need to put Forge.toml file containing list of aliases next to global installation of Forge.exe
  2. Repository - you need to put Forge.toml file in repository root.

Aliases for smaller scopes can override aliases from more general scope (global aliases can override default, local overrides both default and global) in case of using same key.