# hk-manifest

> A Heroku hk CLI plugin for creating app.json manifests

Latest version **0.2.0** (published 2014-04-01) · MIT license · 0 weekly downloads

## Install

```sh
npm install hk-manifest
pnpm add hk-manifest
yarn add hk-manifest
bun add hk-manifest
```

Provides the command `hk-manifest`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.0 |
| Published | 2014-04-01 |
| First published | 2014-04-01 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 6 |
| Known vulnerabilities | 0 (+2 in 2 direct dependencies) |
| Install scripts | yes |
| Author | zeke |
| Maintainers | zeke |

## Links

- npm: https://www.npmjs.com/package/hk-manifest
- npm.io page: https://npm.io/package/hk-manifest

## Dependencies (6)

- [is-url](https://npm.io/package/is-url.md) ~0.1.0
- [prompt](https://npm.io/package/prompt.md) ~0.2.11
- [flatten](https://npm.io/package/flatten.md) 0.0.1
- [iniparser](https://npm.io/package/iniparser.md) ~1.0.5
- [superagent](https://npm.io/package/superagent.md) ~0.15.7
- [heroku-client](https://npm.io/package/heroku-client.md) ^1.2.0

## Recent versions

- 0.2.0 (latest) — 2014-04-01
- 0.1.1 — 2014-04-01
- 0.1.0 — 2014-04-01

## README

# hk-manifest

`hk-manifest` is an [hk](https://github.com/heroku/hk) plugin for creating
app.json files.

When you run it, it looks in the current directory for clues about the app, such
a `.git` directory, a package.json, or a heroku git remote, and uses those to
set sensible defaults for your app.json manifest

## Installation

hk-manifest is a node module. If you need node, download the installer from [nodejs.org](http://nodejs.org/).

hk-manifest is a command line interface, so it should be installed globally with the `-g` or `--global` flag.

To work as an hk plugin, hk-manifest symlinks itself to `/usr/local/lib/hk/plugin/`.

```
npm install hk-manifest --global
```

## Usage

Run `hk manifest` in some directory.

```
cd my-cool-project
hk manifest
```

You'll see something like this:

```
small-sharp-tool $ hk manifest
Give your app a unique, URL-friendly name. (small-sharp-tool)
In just a few words, what is it? It does one thing, and does it well.
Enter some keywords, separated by commas. unix, microservice, http
What's the source URL? It can be a git(hub) URL or a tarball. https://github.com/jane/small-sharp-tool
If there's a website about this app, what is its URL? https://small-sharp-tool.com

{
  "name": "small-sharp-tool",
  "description": "It does one thing, and does it well.",
  "keywords": [
    "unix",
    "microservice",
    "http"
  ],
  "urls": {
    "source": "https://github.com/jane/small-sharp-tool",
    "website": "https://small-sharp-tool.com"
  }
}

Created app.json
```

## Development

To use your locally cloned copy of hk-manifest on the command line:

```
cd my/fork/of/hk-manifest
npm link
```

To remove any `npm install`ed or `npm link`ed instance:

```
npm remove hk-manifest -g
```

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