Narwhals Playing Mahjong

    @salesforce/plugin-alias

    2.1.5 • Public • Published

    plugin-alias

    NPM CircleCI Downloads/week License

    Alias commands for Salesforce CLI

    This plugin is bundled with the Salesforce CLI. For more information on the CLI, read the getting started guide.

    We always recommend using the latest version of these commands bundled with the CLI, however, you can install a specific version or tag if needed.

    Install

    sfdx plugins:install alias@x.y.z

    Issues

    Please report any issues at https://github.com/forcedotcom/cli/issues

    Contributing

    1. Please read our Code of Conduct
    2. Create a new issue before starting your project so that we can keep track of what you are trying to add/fix. That way, we can also offer suggestions or let you know if there is already an effort in progress.
    3. Fork this repository.
    4. Build the plugin locally
    5. Create a topic branch in your fork. Note, this step is recommended but technically not required if contributing using a fork.
    6. Edit the code in your fork.
    7. Write appropriate tests for your changes. Try to achieve at least 95% code coverage on any new code. No pull request will be accepted without unit tests.
    8. Sign CLA (see CLA below).
    9. Send us a pull request when you are done. We'll review your code, suggest any needed changes, and merge it in.

    CLA

    External contributors will be required to sign a Contributor's License Agreement. You can do so by going to https://cla.salesforce.com/sign-cla.

    Build

    To build the plugin locally, make sure to have yarn installed and run the following commands:

    # Clone the repository
    git clone git@github.com:salesforcecli/plugin-alias
    
    # Install the dependencies and compile
    yarn install
    yarn build

    To use your plugin, run using the local ./bin/run or ./bin/run.cmd file.

    # Run using local run file.
    ./bin/run alias

    There should be no differences when running via the Salesforce CLI or using the local run file. However, it can be useful to link the plugin to do some additional testing or run your commands from anywhere on your machine.

    # Link your plugin to the sfdx cli
    sfdx plugins:link .
    # To verify
    sfdx plugins

    Commands

    sfdx alias:list [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

    list username aliases for the Salesforce CLI

    USAGE
      $ sfdx alias:list [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
    
    FLAGS
      --json                                                                            format output as json
      --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for
                                                                                        this command invocation
    
    DESCRIPTION
      list username aliases for the Salesforce CLI
    
    ALIASES
      $ sfdx force:alias:list
    

    See code: src/commands/alias/list.ts

    sfdx alias:set name=value... [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

    set username aliases for the Salesforce CLI

    USAGE
      $ sfdx alias:set name=value... [--json] [--loglevel
        trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
    
    FLAGS
      --json                                                                            format output as json
      --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for
                                                                                        this command invocation
    
    DESCRIPTION
      set username aliases for the Salesforce CLI
    
      You can associate an alias with only one username at a time. If you’ve set an alias multiple times, the alias points
      to the most recent username.
    
    ALIASES
      $ sfdx force:alias:set
    
    EXAMPLES
      $ sfdx alias:set YourAlias=username@example.com
    
      $ sfdx alias:set YourAlias=username@example.com YourOtherAlias=devhub@example.com
    

    See code: src/commands/alias/set.ts

    sfdx alias:unset [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

    unsets aliases for the Salesforce CLI

    USAGE
      $ sfdx alias:unset [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
    
    FLAGS
      --json                                                                            format output as json
      --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for
                                                                                        this command invocation
    
    DESCRIPTION
      unsets aliases for the Salesforce CLI
    
    EXAMPLES
      $ sfdx alias:unset YourAlias
    
      $ sfdx alias:unset YourAlias YourOtherAlias
    

    See code: src/commands/alias/unset.ts

    sfdx force:alias:list [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

    list username aliases for the Salesforce CLI

    USAGE
      $ sfdx force:alias:list [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
    
    FLAGS
      --json                                                                            format output as json
      --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for
                                                                                        this command invocation
    
    DESCRIPTION
      list username aliases for the Salesforce CLI
    
    ALIASES
      $ sfdx force:alias:list
    

    sfdx force:alias:set name=value... [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

    set username aliases for the Salesforce CLI

    USAGE
      $ sfdx force:alias:set name=value... [--json] [--loglevel
        trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
    
    FLAGS
      --json                                                                            format output as json
      --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for
                                                                                        this command invocation
    
    DESCRIPTION
      set username aliases for the Salesforce CLI
    
      You can associate an alias with only one username at a time. If you’ve set an alias multiple times, the alias points
      to the most recent username.
    
    ALIASES
      $ sfdx force:alias:set
    
    EXAMPLES
      $ sfdx alias:set YourAlias=username@example.com
    
      $ sfdx alias:set YourAlias=username@example.com YourOtherAlias=devhub@example.com
    

    Install

    npm i @salesforce/plugin-alias

    DownloadsWeekly Downloads

    54,864

    Version

    2.1.5

    License

    BSD-3-Clause

    Unpacked Size

    31.5 kB

    Total Files

    23

    Last publish

    Collaborators

    • duane.chew
    • dferro
    • jcourtner
    • jye-sf
    • adirasanam
    • hkii
    • mcasado
    • iamaziz
    • dlouvton
    • jc-sf
    • pvandyk-sf
    • dbreese-salesforce
    • ashokrudraraju
    • dhersam
    • demianbrecht
    • mbettio
    • damilareolowoniyi
    • mmadialagan
    • spoorti.nidagundi
    • rodesp
    • mjrust
    • salesforce-releases
    • conal
    • vazexqi
    • joshwlewis
    • mpsenn
    • sfdc_iamigo
    • kevinv11n
    • tbliss
    • byao
    • pmdartus
    • futuremint_sf
    • ekashida
    • gr8gatsby
    • ravi.jayaramappa
    • apapko
    • krisgraysfdc
    • jleen-sfdc
    • jqian
    • cwallsf
    • dhagberg-sf
    • michaelhoefer
    • tlohr
    • khawkins
    • amphro
    • tconn
    • dehru
    • abdulsattar
    • jodarove
    • rxu-sfdc
    • amcconnell-sf
    • nolanlawson
    • sfdctaka
    • fernomac
    • cafreeman
    • jimjag
    • ivarley
    • jbartolotta-sfdc