{"id":13505699,"url":"https://github.com/Esri/arcgis-js-cli","last_synced_at":"2025-03-30T00:31:25.896Z","repository":{"id":32433621,"uuid":"132804458","full_name":"Esri/arcgis-js-cli","owner":"Esri","description":"CLI to build a template application and widgets using the ArcGIS API for JavaScript","archived":true,"fork":false,"pushed_at":"2024-02-02T21:45:25.000Z","size":1589,"stargazers_count":140,"open_issues_count":0,"forks_count":31,"subscribers_count":24,"default_branch":"master","last_synced_at":"2025-03-18T13:45:59.378Z","etag":null,"topics":["arcgis-js-api","cli","flow","javascript"],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Esri.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-05-09T19:36:37.000Z","updated_at":"2024-10-02T15:17:53.000Z","dependencies_parsed_at":"2024-01-08T09:04:23.531Z","dependency_job_id":"2c6bc3d3-fd18-4cbf-b7de-0c5a846abaa4","html_url":"https://github.com/Esri/arcgis-js-cli","commit_stats":{"total_commits":148,"total_committers":14,"mean_commits":"10.571428571428571","dds":"0.20270270270270274","last_synced_commit":"ba98593bb27f56cbc96cfcdc55dc408f97a3b120"},"previous_names":[],"tags_count":36,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Esri%2Farcgis-js-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Esri%2Farcgis-js-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Esri%2Farcgis-js-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Esri%2Farcgis-js-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Esri","download_url":"https://codeload.github.com/Esri/arcgis-js-cli/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246262490,"owners_count":20749170,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["arcgis-js-api","cli","flow","javascript"],"created_at":"2024-08-01T00:01:11.859Z","updated_at":"2025-03-30T00:31:20.888Z","avatar_url":"https://github.com/Esri.png","language":"TypeScript","funding_links":[],"categories":["Application generators and CLIs"],"sub_categories":[],"readme":"# @arcgis/cli (Deprecated)\n\n| :warning: This repository has been archived  |\n| :--------------------------------------------|\n| **This package is no longer supported. Use at your own risk.** |\n\nThis CLI will allow you to quickly scaffold various applications for the [ArcGIS Maps SDK JavaScript](https://developers.arcgis.com/javascript/).\n\n\u003e NOTE: It is highly recommended that you use [Vite](https://vitejs.dev/) directly to build your apps. We also provide a number of [application samples](https://github.com/Esri/jsapi-resources/tree/master/esm-samples) that you can use. The 4.25 release of this CLI will most likely be the last release. There are other tools already suited for using existing repositories for applications, such as [degit](https://github.com/Rich-Harris/degit).\n\n## 4.25 Breaking Changes\n\nThere is no longer a webpack template provided for this CLI. The only application template uses [Vite](https://vitejs.dev/). You can find webpack application sample [here](https://github.com/Esri/jsapi-resources/tree/master/esm-samples/webpack).\n\n## Usage\n\n### Prerequisites\n\nYou will need node v8+.\n\n* _NOTE FOR WINDOWS USERS_ - You may need to install the [Windows-Build-Tools](https://github.com/felixrieseberg/windows-build-tools) to compile npm modules for this project. `npm install --global --production windows-build-tools`\n\n### Installation\n\nFrom NPM\n\n`npm install -g @arcgis/cli`\n\nIn a terminal, run: \n\n`arcgis --help`\n\nThis will output the following: \n\n```sh\nUsage: arcgis \u003cname\u003e [dest] -t \u003ctype\u003e\n\nCommands:\n  arcgis create \u003cname\u003e [dest]  Create a new application.\n  arcgis init [type]           Initialize a new application in current directory\n  arcgis widget \u003cname\u003e [type]  Create a new Widget.\n  arcgis styles \u003csubcommand\u003e   Run commands to work with a custom CSS\n                               theme\n```\n\n## Quick Start\n\n\u003e template application\n```sh\narcgis create jsapi-app\n```\n\n## Sample Apps\n\n* [ArcGIS Basic App](https://jsapi-basic-416.surge.sh/)\n\n\n## Features\n\n\n### Create a new application\n\n```sh\n$ arcgis create \u003cname\u003e [dest]\n\nCreate a new application.\n\nOptions:\n  --version   Show version number                                                        [boolean]\n  --name, -n  directory and package name for the new app\n  --dest      Directory to create the application in                                     [default: \u003cname\u003e]\n  --type, -t  A project template           [choices: \"jsapi\"] [default: \"jsapi\"]\n  -h, --help  Show help                                                                  [boolean]\n\n```\n\n### Initialize a new application in current directory\n\n```sh\n$ arcgis init [type]\n\nInitialize a new application in current directory\n\nOptions:\n  --version   Show version number                                                        [boolean]\n  --type, -t  A project template           [choices: \"jsapi\"]                  [default: \"jsapi\"]\n  -h, --help  Show help                                                                  [boolean]\n```\n\n### Create a new widget\n\nYou can scaffold a standalone widget for use in your application. Widgets are saved into a `tmp` folder.\n\n```sh\n$ arcgis widget \u003cname\u003e [type]\n\nCreate a new Widget.\n\nOptions:\n  --version   Show version number                                      [boolean]\n  --name, -n  Name of new widget\n  --type, -t  A widget template            [choices: \"jsapi\", \"exb\"] [default: \"jsapi\"]\n  -h, --help  Show help                                                [boolean]\n```\n\n#### Experience Builder Widgets\n\nThe CLI can be used to scaffold custom widgets for the [ArcGIS Experience Builder Developer Edition](https://www.esri.com/en-us/arcgis/products/arcgis-experience-builder/overview).\n\nYou will want to run the CLI in the extracted root directory of your Experience Builder installation.\n\n```sh\narcgis widget my-widget -t exb\n```\n\nThis will install your widget in the Experience Builder folder structure as follows.\n\n```\n\u003cExperience-Builder-Installation\u003e\\client\\your-extensions\\widgets\\MyWidget\\\n```\n      \n### Author a custom theme\n\nCreate a new CSS theme.\n\n```sh\n$ arcgis styles \u003csubcommand\u003e\n\nRun subcommands to work with a custom CSS theme\n\nCommands:\n  arcgis styles create [theme]   Create a custom theme\n  arcgis styles preview [theme]  Launch theme-preview test page\n  arcgis styles eject [theme]    Eject a built theme ready for deployment\n  arcgis styles list             List existing themes in the current project\n  arcgis styles clean            Removes any local scaffolding. This should be\n                                 used when no more theme authoring is to be done\n                                 in the working directory.\n  arcgis styles scaffold         Sets up project scaffolding. This is done\n                                 automatically when creating a theme for the\n                                 first time.\n```\n\n#### Create a new theme\n\n```sh\n$ arcgis styles create [theme]\n\nCreate a custom theme\n\nPositionals:\n  theme  the name of the theme to create   [string] [default: \"my-custom-theme\"]\n\nOptions:\n      --version            Show version number                             [boolean]\n      -e, --with-examples  when specified, the created theme will include examples\n                           from the SDK                                    [boolean]\n      -b, --with-base      when specified, the created theme will include base files\n                           for local overrides (advanced)                  [boolean]\n      -f, --force          overwrites a theme if it already exists         [boolean]\n      -h, --help           Show help                                       [boolean]\n```\n\n#### Preview a theme\n\n```sh\n$ arcgis styles preview [theme]\n\nLaunch theme-preview test page\n\nPositionals:\n  theme  the name of the theme to preview (this is only needed if there is more\n         than one theme in the workspace)  [string] [default: \"my-custom-theme\"]\n\nOptions:\n      --version      Show version number                                   [boolean]\n      -p, --port     port to use for the preview page                       [number]\n      -h, --help     Show help                                             [boolean]\n```\n                     \n#### Eject a theme \n\n```sh\n$ arcgis styles eject [theme]\n\nEject a built theme ready for deployment\n\nPositionals:\n  theme  the name of the theme to eject (this is only needed if there is more\n         than one theme in the workspace)  [string] [default: \"my-custom-theme\"]\n\nOptions:\n      --version      Show version number                                   [boolean]\n      -h, --help     Show help                                             [boolean]\n```\n\n#### List themes\n\n```sh\n$ arcgis styles list\n\nList existing themes in the current project\n\nOptions:\n      --version      Show version number                                   [boolean]\n      -h, --help     Show help                                             [boolean]\n```\n\n#### Clean themes workspace\n\n```sh\n$ arcgis styles clean\n\nRemoves any local scaffolding. This should be used when no more theme authoring\nis to be done in the working directory.\n\nOptions:\n      --version      Show version number                                   [boolean]\n      -f, --force    required to clean any local scaffolding used by this utility\n                                                                           [boolean]\n      -h, --help     Show help                                             [boolean]\n```\n\n#### Scaffold styling workspace\n\n```sh\n$ arcgis styles scaffold\n\nSets up project scaffolding. This is done automatically when creating a theme\nfor the first time.\n\nOptions:\n      --version      Show version number                                   [boolean]\n      -f, --force    forces creation of project scaffolding                [boolean]\n      -h, --help     Show help                                             [boolean]\n```\n\n## Licensing\nCopyright 2022 Esri\n\nLicensed 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\n\nhttp://www.apache.org/licenses/LICENSE-2.0\n\nUnless 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.\n\nA copy of the license is available in the repository's [LICENSE](./LICENSE) file\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FEsri%2Farcgis-js-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FEsri%2Farcgis-js-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FEsri%2Farcgis-js-cli/lists"}