# adsk-forge-cli

> Interact with Forge API from the command line.

Latest version **1.0.1** (published 2017-04-07) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install adsk-forge-cli
pnpm add adsk-forge-cli
yarn add adsk-forge-cli
bun add adsk-forge-cli
```

Provides the command `forge-cli`.

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2017-04-07 |
| First published | 2017-04-07 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 7 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 9 |
| Author | Martin Alonso |
| Maintainers | alonsom |

## Links

- npm: https://www.npmjs.com/package/adsk-forge-cli
- Repository: https://github.com/Autodesk/forge-cli
- Homepage: https://github.com/Autodesk/forge-cli#readme
- Issues: https://github.com/Autodesk/forge-cli/issues
- npm.io page: https://npm.io/package/adsk-forge-cli

## Dependencies (7)

- [debug](https://npm.io/package/debug.md) ^2.2.0
- [prompt](https://npm.io/package/prompt.md) ^1.0.0
- [yamljs](https://npm.io/package/yamljs.md) ^0.2.8
- [commander](https://npm.io/package/commander.md) ^2.9.0
- [jsonschema](https://npm.io/package/jsonschema.md) ^1.1.0
- [node-fetch](https://npm.io/package/node-fetch.md) ^1.6.1
- [app-root-path](https://npm.io/package/app-root-path.md) ^2.0.1

## Recent versions

- 1.0.1 (latest) — 2017-04-07
- 1.0.0 — 2017-04-07

## README

# Forge Command Line Interface (CLI)
The Forge Command Line Interface (CLI) is a unified tool to manage your Forge services.
Using Forge CLI you can create, update, query and delete resources in your Forge account from the command line.
Use Forge CLI to automate the build and deploy process of Forge depended services.

## Contributing guidelines
See [CONTRIBUTING](https://git.autodesk.com/AutoCAD360/forge-cli/blob/master/CONTRIBUTING.md)

## Usage

| Step | Command                                                                  | Description                                                                                                                                |
| ---- | ------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ |
| 1    | `mkdir my-forge-da-app && cd my-forge-da-app` | Create the project directory                                                                                                                             |
| 2    | `npm init`                            | Initialize npn in your directory                                                                                                              |
| 3    | `npm install adsk-forge-cli`                                            | Install Forge CLI                                                                                                                          |
| 4    | [Create a Forge app](https://developer.autodesk.com/myapps/create)   | Get Forge app id and secret                                                                                                                |
| 5    | `node_modules/.bin/forge-cli configure -i [FORGE_ID] -s [FORGE_SECRET]`  | Connect Forge CLI with your Forge app                                                                                                      |
| 6    | `node_modules/.bin/forge-cli generate`                                   | Generate a [Forge resources sample yaml](https://github.com/Autodesk/forge-cli/blob/master/templates/forge-resources-template.yml) |
| 7    | `node_modules/.bin/forge-cli deploy`                                     | Deploy resources to Forge                                                                                                                  |

## Commands

```Usage: forge-cli [command] [options]```

### configure [options]
Set up User ID and Secret

  Options:

    -i, --id [value]       Optional Client ID
    -s, --secret [value]   Optional Client Secret
    -p, --profile [value]  Optional Profile Name (default is 'default')
    -h, --help             output usage information

### generate
Generates a Forge resource yaml file where to add your resources

### deploy
Apply the changes required to reach the desired state of the configuration as
specified by the forge-resources.yml. This may include creating, updating, or deleting resources.

  Options:

    -p, --plan  Display a deploy plan without deploying anything

Plan Example:
```
  DesignAutomationAPI:

  ~ steps-overkill
  + drawLine
  - steps-distil
  - oldDrawLine

 ```

 In the above example `steps-overkill` will be updated, `drawLine` will be created
 and `steps-distil` and `oldDrawLine` will be deleted.

### da [options]
Design Automation API commands

  Options:

    -h, --help         output usage information
    -l, --list <type>  List the DA resources available in the Forge app according the specified type [activities]

### help

    -h, --help  output usage information

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