extension-cli - GitLite

KO | EN

gitlite — search

#python #hacktoberfest #typescript #machine-learning #rust #macos #java #awesome #cli #vue #awesome-list #mcp #openai #open-source

extension-cli

(★ 186)

Command line tool for building extensions/add-ons for chromium based browsers.

File Explorer

Download Latest Version (.zip)

- - bug_report.md
  - feature_request.md
- - codeql-analysis.yml
  - publish.yml
- changelog.md
- code_of_conduct.md
- contributing.md
- feature.png
- gulpfile.js
- rootsuite.js
- texts.js
- utilities.js
- xt-build.js
- xt-clean.js
- xt-create.js
- xt-docs.js
- xt-sync.js
- xt-test.js
- - 128x128.png
  - 16x16.png
  - 24x24.png
  - 32x32.png
  - background.js
  - eslint.json
  - icon.svg
  - intro.md
  - manifest.json
  - messages.json
  - package.json
  - test.js
- actions.yml
- build.json
- docs.json
- gitlab.yml
- ignore
- readme.md
- travis.yml
- - custom.css
  - custom.js
- - main.html
- 01-getting-started.md
- 02-configuration.md
- 03-xt-build-assets.md
- 03-xt-build-cmds.md
- 03-xt-build-copy.md
- 03-xt-build-locales.md
- 03-xt-build-manifest.md
- 03-xt-build-scripts.md
- 03-xt-build-styles.md
- 03-xt-build.md
- 04-xt-clean.md
- 05-xt-docs-templates.md
- 05-xt-docs.md
- 06-xt-sync.md
- 07-xt-test.md
- 08-xt-create.md
- 09-release-notes-0.md
- 09-release-notes.md
- 12-helpful.md
- 13-cli-development.md
- 13-dev-env.md
- 14-user-guide.md
- index.md
- cli-create.test.js
- cli-utilities.test.js
- README.md
.eslintrc
.gitignore
.npmignore
.travis.yml
LICENSE
mkdocs.yml
package-lock.json
package.json
README.md
renovate.json
requirements.txt

# Installation Guide

1. Get the code

git clone https://github.com/MobileFirstLLC/extension-cli

Downloads the entire project code from GitHub to your computer.

cd extension-cli

Moves into the project folder you just downloaded.

2. Node.js

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Node.js Node.js must be installed to use npm. The LTS version is recommended.

npm install extension-cli

Downloads and installs the libraries listed in package.json.

✅ After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

3. Python

Easy

Prerequisites

Git Needed to download the project code from GitHub.
Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.

pip install -r requirements.txt

Installs the Python libraries listed in requirements.txt (or similar).

python <실행할 파일명>.py # README에서 정확한 실행 파일명을 확인하세요

Runs the Python script (or module).

✅ If it runs without errors and prints output in the terminal, it worked.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Extension CLI

[![npm](https://img.shields.io/npm/v/extension-cli?style=flat-square)](https://www.npmjs.com/package/extension-cli)
[![travis](https://img.shields.io/travis/mobilefirstllc/extension-cli?style=flat-square)](https://travis-ci.com/github/MobileFirstLLC/extension-cli)
[![Code Climate maintainability](https://img.shields.io/codeclimate/maintainability/MobileFirstLLC/extension-cli?style=flat-square)](https://codeclimate.com/github/MobileFirstLLC/extension-cli/maintainability)
[![Last commit](https://img.shields.io/github/last-commit/mobilefirstllc/extension-cli?style=flat-square)](https://github.com/MobileFirstLLC/extension-cli/commits/master)
[![npm](https://img.shields.io/npm/dt/extension-cli?style=flat-square)](https://www.npmjs.com/package/extension-cli)

**Extension CLI is a command-line application that facilitates chromium&#8727;-based web extension development by providing
a systematic way to build, test and document extension projects. It handles the project setup and builds and lets you focus 
on the extension you are creating.**

* * *

## Features

-  🖥️ &nbsp; **Javascript Bundling** — Compiles, bundles and minifies javascript files<br/>

-  🎨 &nbsp; **CSS Bundling** — Compiles, bundles, and minifies CSS and [SASS](https://sass-lang.com/guide) files <br/>

-  💄 &nbsp; **Linting** — lint JavaScript using [ESLint](https://eslint.org/) <br/>

-  📦 &nbsp; **ZIP Generation** — Generates a `.zip` file for publishing <br/>

-  📝 &nbsp; **Document Source Code** — Generates code documentation using [JSDoc](https://jsdoc.app/about-getting-started.html) <br/>

-  ⚗️ &nbsp; **Unit Testing** — Provides a unit test environment preloaded with [mocha](https://mochajs.org), [chai](https://www.chaijs.com/) and [sinon-chrome](https://github.com/acvetkov/sinon-chrome) <br/>

-  ⚔️ &nbsp; **Cross-Browser Compatibility** - develop extensions for Chrome, Edge, Firefox, Opera and Brave. <br/>

![feature image](https://raw.githubusercontent.com/MobileFirstLLC/extension-cli/master/.github/feature.png)

## Getting Started

**Note:** Using this CLI assumes you have Node.js installed. If you do not, you can [install it here](https://nodejs.org/en/download/).

##### Create new extension project

```text
npx extension-cli
```

##### Add to an existing project

```text
npm install extension-cli
```

### Commands Reference

Command | Description
--- | ---
**xt-build** | Run builds; env flags: `-e prod` and `-e dev`
**xt-test**| Run unit tests
**xt-docs**| Generate docs
**xt-sync**| Update project config files to match the latest defaults supplied by this CLI
**xt-clean** | Remove automatically generated files

* * *

## Read the Docs

<img align="left" width="64" src="https://raw.githubusercontent.com/MobileFirstLLC/extension-cli/master/guide/assets/images/guide.svg" alt="" /> &nbsp; 
<br/>&nbsp; &nbsp;<strong><a href="https://oss.mobilefirst.me/extension-cli/">User Guide →</a></strong><br/><br/>

### CLI Developer Guide

If you are interested in extending this project or forking **[see this guide &rarr;](https://oss.mobilefirst.me/extension-cli/13-cli-development/)**

* * *

## Motivation

After developing multiple browser extensions, it became clear that there are several steps in the development process that stay the same between every project.

Instead of setting up these tasks individually for each project, it made more sense to combine everything in a utility tool that could be shared between projects.

This approach helps with creating a common, consistent development approach between multiple projects, reduces time to get started, and makes it easier to update build tools and scripts across multiple projects as many npm packages inevitably need to be updated (frequently!).

* * *

**Issues & Feature Requests:** [Submit on Github](https://github.com/MobileFirstLLC/extension-cli/issues/new/choose)

**Maker:** made by <a href="https://github.com/MobileFirstLLC/extension-cli/graphs/contributors" target="_blank" rel="noreferrer noopener">developers</a> behind several popular extensions!

**License:** [MIT](https://github.com/MobileFirstLLC/extension-cli/blob/master/LICENSE)