arcgis-lib-downloader

npm package for gaining access to ArcGIS programs

Usage no npm install needed!

<script type="module">
  import arcgisLibDownloader from 'https://cdn.skypack.dev/arcgis-lib-downloader';
</script>

README

ArcGIS Lib Downloader

Download ArcGIS developer libraries from the terminal

Installation

npm install arcgis-lib-downloader

Quick Start

To download a library:

  1. Install the library: npm install arcgis-lib-downloader
  2. See the available products with arcgis-lib-downloader --list-products
  3. Take a product Key from the previous step (for example, qt) and see the versions: arcgis-lib-downloader --list-versions --product qt
  4. Take a product Version from the previous step (for example, 100.11.2) and download that version of the library: arcgis-lib-downloader --product qt --version 100.11.2

Options

Option Description
--list-products Lists the different products available for download and other information about them.
--list-versions List more detailed information about the versions available for a product. Pass in the short name of the product. For example, arcgis-lib-downloader --list-versions --product qt
-p, --product <product> Specify the product. Pass the product short name obtained from arcgis-lib-downloader --list-products.
-v, --version <version> Specify the version number that you would like to download, or leave blank to download the most recent version.
--user <username> Your ArcGIS Online username. Required if not providing credentials via another method (see "Other options to provide credentials" below).
--password <password> Your ArcGIS Online password. Required if not providing credentials via another method.
-h, --help See the help documentation - available commands, etc.
-V, --Ver Output the tool version number. Note the capitalization difference between this option and the --ver option above.

Examples

Download the ArcGIS API for JavaScript v4.19, passing a username and password:

arcgis-lib-downloader -p javascript -v 4.19 --user 'abc123' --password 'def456'

Other options to provide credentials

To utilize environment variables as a method of authenticating your ArcGIS Online credentials:

  1. Create a .env file in the same directory that you are working with the ArcGIS Lib Downloader.
  2. On the first line of the .env file, type in: ARCGIS_LIB_DOWNLOADER_USERNAME = insert YOUR username here
  3. On the second line of the .env file, type in: ARCGIS_LIB_DOWNLOADER_PASSWORD = insert YOUR password here
  4. Now when you run the lib downloader, it is not necessary to enter your credentials using the --user and --password switches.

Contributing

This project was created using Node.js. If you wish to contribute and suggest changes to enhance the performance of the lib downloader, first make sure that you have Node and npm installed on your machine. Next, you are either going to need to clone this repository and create a local version on your machine or create a Pull Request that can be reviewed by one of the contributors of this repository.