# @hammerframework/hammer-cli

> The Hammer Command Line

Latest version **0.0.1-alpha.14** (published 2019-12-24) · MIT license · 0 weekly downloads

## Install

```sh
npm install @hammerframework/hammer-cli
pnpm add @hammerframework/hammer-cli
yarn add @hammerframework/hammer-cli
bun add @hammerframework/hammer-cli
```

Provides the command `hammer`.

## Health

**Score 35/100 (D)** — status: abandoned.

Positive: no vulnerabilities; high maintenance score; popular repo.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 0.0.1-alpha.14 |
| Published | 2019-12-24 |
| First published | 2019-06-30 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 12 |
| Unpacked size | 23.8 KB |
| Known vulnerabilities | 0 (+31 in 3 direct dependencies) |
| Install scripts | no |
| GitHub stars | 17587 |
| Maintainers | mojombo, peter.pistorius |

## Links

- npm: https://www.npmjs.com/package/@hammerframework/hammer-cli
- Repository: https://github.com/hammerframework/hammer.git
- Homepage: https://github.com/hammerframework/hammer.git#readme
- Issues: https://github.com/hammerframework/hammer.git/issues
- npm.io page: https://npm.io/package/@hammerframework/hammer-cli

## Dependencies (12)

- [ink](https://npm.io/package/ink.md) ^2.2.0
- [tmp](https://npm.io/package/tmp.md) ^0.1.0
- [axios](https://npm.io/package/axios.md) ^0.19.0
- [react](https://npm.io/package/react.md) 16.12.0
- [core-js](https://npm.io/package/core-js.md) 3.6.0
- [camelcase](https://npm.io/package/camelcase.md) ^5.3.1
- [decompress](https://npm.io/package/decompress.md) ^4.2.0
- [require-dir](https://npm.io/package/require-dir.md) ^1.2.0
- [yarn-or-npm](https://npm.io/package/yarn-or-npm.md) ^3.0.1
- [concurrently](https://npm.io/package/concurrently.md) ^5.0.0
- [yargs-parser](https://npm.io/package/yargs-parser.md) ^13.1.1
- [@hammerframework/hammer-core](https://npm.io/package/@hammerframework/hammer-core.md) ^0.0.1-alpha.14

## Recent versions

- 0.0.1-alpha.14 (latest) — 2019-12-24
- 0.0.1-alpha.12.5 — 2019-11-01
- 0.0.1-alpha.12.1 — 2019-10-30
- 0.0.1-alpha.12 — 2019-10-29
- 0.0.1-alpha.10 — 2019-10-22
- 0.0.1-alpha.9.2 — 2019-10-03
- 0.0.1-alpha.9.1 — 2019-09-30
- 0.0.1-alpha.9 — 2019-09-30
- 0.0.1-alpha.8 — 2019-09-12
- 0.0.0-alpha.5 — 2019-07-04
- 0.0.0-alpha.4 — 2019-06-30

## README

# The Hammer Command Line

## Installation

We recommend that you install Hammer's CLI globally
with npm `npm install -g @hammerframework/hammer-cli` or with
yarn `yarn global add @hammerframework/hammer-cli`.

## Command line basics

### `hammer new`

The first thing we'll want to do is create a new Hammer application by running the
`hammer new` command after installation.

```terminal
$ yarn new ~/myprojects/todo
Created ~/myprojects/todo
Downloading https://github.com/hammerframework/create-hammer-app/archive/v0.0.1-alpha.7.zip...
Extracting...
Added 50 files in ~/myprojects/todo
```

## Development

Run `yarn dev` to automatically reload the

Add a new command by creating `CommandName/CommandName.js` file in the
`./src/commands` directory.

A command should export the following:

```js
export default ({ args }) => {} // The react-ink component.
export const commandProps = {
  name: 'generate',
  alias: 'g', // invoke with hammer s instead of hammer scaffold,
  description: 'This command does a, b, but not c.',
}
```

## Publishing

This is a monorepo and is published via LearnaJS. See the root README for instructions.

---
_Source: https://npm.io/package/@hammerframework/hammer-cli · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._