https://github.com/yeoman/environment

Yeoman runtime environment
https://github.com/yeoman/environment

Last synced: 3 months ago
JSON representation

Yeoman runtime environment

• Host: GitHub
• URL: https://github.com/yeoman/environment
• Owner: yeoman
• License: bsd-2-clause
• Created: 2014-09-29T06:02:18.000Z (about 10 years ago)
• Default Branch: main
• Last Pushed: 2024-04-11T14:27:36.000Z (7 months ago)
• Last Synced: 2024-04-11T17:13:32.381Z (7 months ago)
• Language: JavaScript
• Size: 6.89 MB
• Stars: 125
• Watchers: 15
• Forks: 70
• Open Issues: 3
• Metadata Files:
  • Readme: readme.md
  • Funding: .github/FUNDING.yml
  • License: license

Awesome Lists containing this project

README

        
# Yeoman Environment

[![npm](https://badge.fury.io/js/yeoman-environment.svg)](http://badge.fury.io/js/yeoman-environment) [![Build Status](https://travis-ci.org/yeoman/generator.svg?branch=master)](https://travis-ci.org/yeoman/environment) [![Coverage Status](https://coveralls.io/repos/github/yeoman/environment/badge.svg?branch=master)](https://coveralls.io/github/yeoman/environment?branch=master) [![Gitter](https://img.shields.io/badge/Gitter-Join_the_Yeoman_chat_%E2%86%92-00d06f.svg)](https://gitter.im/yeoman/yeoman)

> Handles the lifecycle and bootstrapping of generators in a specific environment

It provides a high-level API to discover, create and run generators, as well as further tuning of where and how a generator is resolved.

## Install

```

$ npm install yeoman-environment

```

## Usage

Full documentation available [here](http://yeoman.io/authoring/integrating-yeoman.html).

```js

import { createEnv } from 'yeoman-environment';

// The #lookup() method will search the user computer for installed generators

// The search if done from the current working directory

await env.lookup();

await env.run('angular', { skipInstall: true });

```

For advance usage, see [our API documentation for latest yeoman-environment](http://yeoman.github.io/environment).

[API documentation for yeoman-environment v2.x](http://yeoman.github.io/environment/2.x).

## License

BSD-2-Clause © Yeoman