All Projects → Esri → Arcgis Js Cli

Esri / Arcgis Js Cli

Licence: apache-2.0
CLI to build a template application and widgets using the ArcGIS API for JavaScript

Programming Languages

javascript
184084 projects - #8 most used programming language
typescript
32286 projects
flow
126 projects

Labels

Projects that are alternatives of or similar to Arcgis Js Cli

Passbolt cli
Command line interface for passbolt API
Stars: ✭ 99 (-2.94%)
Mutual labels:  cli
Sysbox
sysadmin/scripting utilities, distributed as a single binary
Stars: ✭ 101 (-0.98%)
Mutual labels:  cli
Xnbcli
A CLI tool for XNB packing/unpacking purpose built for Stardew Valley.
Stars: ✭ 101 (-0.98%)
Mutual labels:  cli
Shtab
↔️ Automagic shell tab completion for Python CLI applications
Stars: ✭ 99 (-2.94%)
Mutual labels:  cli
Playerctl
🎧 mpris media player command-line controller for vlc, mpv, RhythmBox, web browsers, cmus, mpd, spotify and others.
Stars: ✭ 1,365 (+1238.24%)
Mutual labels:  cli
Gql
Very simple CLI for many GraphQL schemas in the cloud. Provides autocompletion for GraphQL queries
Stars: ✭ 101 (-0.98%)
Mutual labels:  cli
Cryptocurrency Cli
💰 Cryptocurrency Portfolio On The Command Line 💰
Stars: ✭ 99 (-2.94%)
Mutual labels:  cli
Py Todo
📋 Lightweight reminder / todo-list in cli
Stars: ✭ 102 (+0%)
Mutual labels:  cli
Npm Quick Run
Quickly run NPM script by prefix without typing the full name
Stars: ✭ 97 (-4.9%)
Mutual labels:  cli
Tmux Xpanes
Awesome tmux-based terminal divider
Stars: ✭ 1,370 (+1243.14%)
Mutual labels:  cli
Snitch
Snitch is the tool that keeps your tests under surveillence.
Stars: ✭ 100 (-1.96%)
Mutual labels:  cli
Ask Cli
Alexa Skills Kit Command Line Interface
Stars: ✭ 100 (-1.96%)
Mutual labels:  cli
Typescript To Cli
Transform your typescript module into a CLI
Stars: ✭ 101 (-0.98%)
Mutual labels:  cli
Udict
A command line urban dictionary.
Stars: ✭ 99 (-2.94%)
Mutual labels:  cli
Ruby Progressbar
Ruby/ProgressBar is a text progress bar library for Ruby.
Stars: ✭ 1,378 (+1250.98%)
Mutual labels:  cli
Cli
Yet another Crystal library for building command-line interface applications.
Stars: ✭ 99 (-2.94%)
Mutual labels:  cli
Redis Cui
Simple, visual command line tool for redis
Stars: ✭ 101 (-0.98%)
Mutual labels:  cli
Tree Node Cli
🌲 Node.js library to list the contents of directories in a tree-like format, similar to the Linux tree command
Stars: ✭ 102 (+0%)
Mutual labels:  cli
Csv2db
The CSV to database command line loader
Stars: ✭ 102 (+0%)
Mutual labels:  cli
Linter Farch
Make sure the filenames stay the same, control them! 👁
Stars: ✭ 101 (-0.98%)
Mutual labels:  cli

@arcgis/cli

npm version build status apache licensed

This CLI will allow you to quickly scaffold various applications for the ArcGIS API for JavaScript.

Usage

Prerequisites

You will need node v8+.

  • NOTE FOR WINDOWS USERS - You may need to install the Windows-Build-Tools to compile npm modules for this project. npm install --global --production windows-build-tools

Installation

From NPM

npm install -g @arcgis/cli

In a terminal, run:

arcgis --help

This will output the following:

Usage: arcgis <name> [dest] -t <type>

Commands:
  arcgis create <name> [dest]  Create a new application.
  arcgis init [type]           Initialize a new application in current directory
  arcgis widget <name> [type]  Create a new Widget.
  arcgis styles <subcommand>   Run commands to work with a custom CSS
                               theme

Quick Start

default template webpack application

arcgis create jsapi-app

rollup template application

arcgis create jsapi-rollup-app -t rollup

template application using CDN

arcgis create jsapi-cdn --cdn

Sample Apps

Features

Create a new application

$ arcgis create <name> [dest]

Create a new application.

Options:
  --version   Show version number                                                        [boolean]
  --name, -n  directory and package name for the new app
  --dest      Directory to create the application in                                     [default: <name>]
  --type, -t  A project template           [choices: "jsapi". "rollup"] [default: "jsapi"]
  --cdn       Project template using JSAPI CDN (outputs a rollup app with CDN)           [default: false]
  -h, --help  Show help                                                                  [boolean]

Initialize a new application in current directory

$ arcgis init [type]

Initialize a new application in current directory

Options:
  --version   Show version number                                                        [boolean]
  --type, -t  A project template           [choices: "jsapi". "rollup"]                  [default: "jsapi"]
  --cdn       Project template using JSAPI CDN (only valid with default or calcite)      [default: false]
  -h, --help  Show help                                                                  [boolean]

Create a new widget

$ arcgis widget <name> [type]

Create a new Widget.

Options:
  --version   Show version number                                      [boolean]
  --name, -n  Name of new widget
  --type, -t  A widget template            [choices: "jsapi", "exb"] [default: "jsapi"]
  -h, --help  Show help                                                [boolean]

Experience Builder Widgets

The CLI can be used to scaffold custom widgets for the ArcGIS Experience Builder Developer Edition.

You will want to run the CLI in the extracted root directory of your Experience Builder installation.

arcgis widget my-widget -t exb

This will install your widget in the Experience Builder folder structure as follows.

<Experience-Builder-Installation>\client\your-extensions\widgets\MyWidget\

Author a custom theme

Create a new CSS theme.

$ arcgis styles <subcommand>

Run subcommands to work with a custom CSS theme

Commands:
  arcgis styles create [theme]   Create a custom theme
  arcgis styles preview [theme]  Launch theme-preview test page
  arcgis styles eject [theme]    Eject a built theme ready for deployment
  arcgis styles list             List existing themes in the current project
  arcgis styles clean            Removes any local scaffolding. This should be
                                 used when no more theme authoring is to be done
                                 in the working directory.
  arcgis styles scaffold         Sets up project scaffolding. This is done
                                 automatically when creating a theme for the
                                 first time.

Create a new theme

$ arcgis styles create [theme]

Create a custom theme

Positionals:
  theme  the name of the theme to create   [string] [default: "my-custom-theme"]

Options:
      --version            Show version number                             [boolean]
      -e, --with-examples  when specified, the created theme will include examples
                           from the API                                    [boolean]
      -b, --with-base      when specified, the created theme will include base files
                           for local overrides (advanced)                  [boolean]
      -f, --force          overwrites a theme if it already exists         [boolean]
      -h, --help           Show help                                       [boolean]

Preview a theme

$ arcgis styles preview [theme]

Launch theme-preview test page

Positionals:
  theme  the name of the theme to preview (this is only needed if there is more
         than one theme in the workspace)  [string] [default: "my-custom-theme"]

Options:
      --version      Show version number                                   [boolean]
      -p, --port     port to use for the preview page                       [number]
      -h, --help     Show help                                             [boolean]

Eject a theme

$ arcgis styles eject [theme]

Eject a built theme ready for deployment

Positionals:
  theme  the name of the theme to eject (this is only needed if there is more
         than one theme in the workspace)  [string] [default: "my-custom-theme"]

Options:
      --version      Show version number                                   [boolean]
      -h, --help     Show help                                             [boolean]

List themes

$ arcgis styles list

List existing themes in the current project

Options:
      --version      Show version number                                   [boolean]
      -h, --help     Show help                                             [boolean]

Clean themes workspace

$ arcgis styles clean

Removes any local scaffolding. This should be used when no more theme authoring
is to be done in the working directory.

Options:
      --version      Show version number                                   [boolean]
      -f, --force    required to clean any local scaffolding used by this utility
                                                                           [boolean]
      -h, --help     Show help                                             [boolean]

Scaffold styling workspace

$ arcgis styles scaffold

Sets up project scaffolding. This is done automatically when creating a theme
for the first time.

Options:
      --version      Show version number                                   [boolean]
      -f, --force    forces creation of project scaffolding                [boolean]
      -h, --help     Show help                                             [boolean]

Issues

Find a bug or want to request a new feature enhancement? Let us know by submitting an issue.

Contributing

Anyone and everyone is welcome to contribute. We do accept pull requests.

  1. Get involved
  2. Report issues
  3. Contribute code
  4. Improve documentation

Licensing

Copyright 2020 Esri

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

A copy of the license is available in the repository's LICENSE file

Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].