https://github.com/petrbroz/forge-cli-utils
Command line tools for Autodesk Forge services.
https://github.com/petrbroz/forge-cli-utils
autodesk cli forge nodejs
Last synced: 6 months ago
JSON representation
Command line tools for Autodesk Forge services.
- Host: GitHub
- URL: https://github.com/petrbroz/forge-cli-utils
- Owner: petrbroz
- Created: 2019-04-17T21:14:44.000Z (over 6 years ago)
- Default Branch: develop
- Last Pushed: 2023-03-04T03:45:18.000Z (over 2 years ago)
- Last Synced: 2025-03-24T06:54:40.061Z (7 months ago)
- Topics: autodesk, cli, forge, nodejs
- Language: JavaScript
- Homepage: https://petrbroz.github.io/forge-cli-utils
- Size: 1.58 MB
- Stars: 18
- Watchers: 2
- Forks: 7
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# forge-cli-utils
[](https://travis-ci.com/petrbroz/forge-cli-utils)
[](https://badge.fury.io/js/forge-cli-utils)
[](http://opensource.org/licenses/MIT)
Command line tools for Autodesk Forge services.
[](https://asciinema.org/a/244057)
## Installation
### Using npm
Install the `forge-cli-utils` library, either in your own npm project
(`npm install --save forge-cli-utils`), or globally (`npm install --global forge-cli-utils`).
### Self-contained binaries
Scripts in this library are also packaged into self-contained binaries for various platforms
using the [pkg](https://www.npmjs.com/package/pkg) module. You can download the binaries from
[release](https://github.com/petrbroz/forge-cli-utils/releases) pages.
## Usage
### Providing Forge credentials
The CLI tools require Forge app credentials to be provided as env. variables.
> If you don't have a Forge app yet, check out this tutorial: https://forge.autodesk.com/en/docs/oauth/v2/tutorials/create-app/.
On macOS and linux:
```bash
export FORGE_CLIENT_ID=
export FORGE_CLIENT_SECRET=
```
On Windows, using _cmd.exe_:
```
set FORGE_CLIENT_ID=
set FORGE_CLIENT_SECRET=
```
On Windows, using PowerShell:
```powershell
$env:FORGE_CLIENT_ID = ""
$env:FORGE_CLIENT_SECRET = ""
```
### Scripts
Use the following scripts for different Forge services:
- `forge-dm` - [Forge Data Management](https://forge.autodesk.com/en/docs/data/v2) service
- `forge-md` - [Forge Model Derivative](https://forge.autodesk.com/en/docs/model-derivative/v2) service
- `forge-da` - [Forge Design Automation](https://forge.autodesk.com/en/docs/design-automation/v3) service
Each script expects a _subcommand_ similar to `git`. To get a list of all available commands,
run the script with `-h` or `--help`.
> When using bash, use the _tools/autocomplete-bash.sh_ script to setup a simple auto-completion
> for the basic commands of each script: `source tools/autocomplete-bash.sh`.
Most commands output raw JSON output from Forge services by default, but in many cases
you can use `-s` or `--short` flag to output a more concise version of the results.
The raw JSON output can also be combined with tools like [jq](https://stedolan.github.io/jq)
to extract just the pieces of information that you need:
```bash
# Listing buckets as full JSON
forge-dm list-buckets
# Listing bucket keys
forge-dm list-buckets --short
# List creation dates of all buckets
forge-dm list-buckets | jq '.[] | .createdDate'
```
### Examples
#### Data Management
```bash
# Listing buckets as full JSON
forge-dm list-buckets
# Listing object IDs of specific bucket
forge-dm list-objects my-test-bucket --short
# Listing object IDs without specifying a bucket (will show an interactive prompt with list of buckets to choose from)
forge-dm list-objects --short
# Getting an URN of an object
forge-dm object-urn my-bucket-key my-object-key
```
#### Design Automation
```bash
# Creating a new app bundle
forge-da create-appbundle BundleName path/to/bundle/zipfile Autodesk.Inventor+23 "Bundle description here."
# Updating existing activity
forge-da update-activity ActivityName BundleName BundleAlias Autodesk.Inventor+23 --input PartFile --output Thumbnail --output-local-name thumbnail.bmp
# Creating work item
forge-da create-workitem ActivityName ActivityAlias --input PartFile --input-url https://some.url --output Thumbnail --output-url https://another.url --short
```
> When specifying inputs and outputs for an activity or work item, `--input-*` and `--output-*` arguments
> are always applied to the last input/output ID. For example, consider the following sequence of arguments:
> `--input InputA --input-local-name house.rvt --input InputB --input InputC --input-url https://foobar.com`.
> Such a sequence will define three inputs: _InputA_ with local name _house.rvt_, _InputB_ (with no additional
> properties), and _InputC_ with URL _https://foobar.com_.
> For more details, see https://github.com/petrbroz/forge-cli-utils/wiki/Design-Automation-Inputs-and-Outputs
#### Model Derivative
```bash
# Translating a model based on its URN
forge-md translate dXJuOmFkc2sub2JqZWN0czpvcy5vYmplY3Q6cG9jLWJvdXlndWVzLWltbW9iaWxpZXIvaW5wdXQucnZ0
# Showing an interactive prompt with all viewables in an URN, and then getting properties of the selected viewable
forge-md get-viewable-props dXJuOmFkc2sub2JqZWN0czpvcy5vYmplY3Q6cG9jLWJvdXlndWVzLWltbW9iaWxpZXIvaW5wdXQucnZ0
# Download the derivatives once translation is completed, -u --guid , -c --directory
forge-md download-derivatives dXJuOmFkc2sub2JqZWN0czpvcy5vYmplY3Q6cG9jLWJvdXlndWVzLWltbW9iaWxpZXIvaW5wdXQucnZ0 -c '/path/to/output/optional' -u 'cdcf63c6-6a67-ffd2-2a8e-1e31397052f7'
```
> For additional examples, check out the _examples_ subfolder.
## Additional Resources
- blog post on auto-deploying Design Automation plugins from Visual Studio: https://forge.autodesk.com/blog/deploying-design-automation-visual-studio