open-index/open-npm huggingface dataset:
npm package: @miragon/digiwf-lib
Description: **Features**
Latest version: 0.1.1

# digiwf-lib

**Features**

- Generates process artifacts and automation projects
- Defines a standard structure for automation projects
- Deploys artifacts to your digiwf instance

- [documentation](https://github.com/FlowSquad/miragon-process-ide/tree/main/docs)
- [examples](https://github.com/FlowSquad/miragon-process-ide-examples)

## Getting started

```
npm install @miragon/digiwf-lib
```

```typescript
import { createDigiwfLib } from "@miragon/digiwf-lib";
import { DigiwfDeploymentPluginRest } from "./digiwf-deployment-plugin-rest";

// init digiwf-lib
const digiwfLib = createDigiwfLib("1.0.0", "my-awesome-project", {
    "forms": "forms",
    "elementTemplates": "element-templates",
    "processConfigs": "configs"
}, [new DigiwfDeploymentPluginRest("rest", [
    {
        "name": "dev",
        "url": "http://localhost:8080"
    }
])]);

const myArtifact = {
    type: "bpmn",
    "project": "my-awesome-project",
    file: {
        name: "my-process",
        extension: "bpmn",
        content: "..."
    }
}; 
    
// deploy file
digiwfLib.deploy("dev", myArtifact)
    .then(success => console.log(success));

// generate new project
digiwfLib.initProject("my-awesome-project")
    .then(artifacts => console.log(artifacts));

// generate new file
digiwfLib.generateArtifact("my-process", "bpmn", "my-awesome-project")
    .then(artifact => console.log(artifact));
```

## More Information

Checkout our

- [documentation](https://github.com/FlowSquad/miragon-process-ide/tree/main/docs)
- [examples](https://github.com/FlowSquad/miragon-process-ide-examples)
npm package: @miragon/miragon-process-ide-cli
Description: **Features**
Latest version: 0.1.1

# Miragon-process-ide-cli

**Features**

- Generates process artifacts and automation projects
- Defines a standard structure for automation projects
- Deploys artifacts to your digiwf instance

- [documentation](https://github.com/FlowSquad/miragon-process-ide/tree/main/docs)

## Getting started

```
npm install @miragon/miragon-process-ide-cli
```

## Usage

```bash
  __  __ _                               _____                               _____ _____  ______
 |  \/  (_)                             |  __ \                             |_   _|  __ \|  ____|
 | \  / |_ _ __ __ _  __ _  ___  _ __   | |__) | __ ___   ___ ___  ___ ___    | | | |  | | |__
 | |\/| | | '__/ _` |/ _` |/ _ \| '_ \  |  ___/ '__/ _ \ / __/ _ \/ __/ __|   | | | |  | |  __|
 | |  | | | | | (_| | (_| | (_) | | | | | |   | | | (_) | (_|  __/\__ \__ \  _| |_| |__| | |____
 |_|  |_|_|_|  \__,_|\__, |\___/|_| |_| |_|   |_|  \___/ \___\___||___/___/ |_____|_____/|______|
                      __/ |
                     |___/


Options:
  -V, --version            output the version number
  -h, --help               display help for command

Commands:
  deploy-file [options]    deploys an artifact to the target environment
  deploy-all [options]     deploys all artifacts to the target environment
  generate-file [options]  generates a process process artifact
  generate [options]       generates a project foundation
  help [command]           display help for command
```

**Deployment**

```bash
# deploy project to target env dev
npx @miragon/miragon-process-ide-cli deploy -d . -t dev

# deploy project example-project to env prod
npx @miragon/miragon-process-ide-cli deploy -d path/to/example-project -t dev
```

**Deploy single file**

```bash
# deploy project to target env dev
npx @miragon/miragon-process-ide-cli deploy-file -f resources/my-process-automation-project/my-process.bpmn -t dev --type bpmn
```

**Generate new project**

```bash
npx @miragon/miragon-process-ide-cli generate --name my-awesome-project --path .
```
npm package: @miragon/miranum-cli
Description: **Features**
Latest version: 0.6.0

# Miranum-cli

**Features**

- Generates process artifacts and automation projects
- Defines a standard structure for automation projects
- Deploys artifacts to your digiwf instance

- [documentation](https://github.com/Miragon/miranum-ide/tree/main/docs)

## Getting started

```
npm install @miragon/miranum-cli
```

## Usage

```bash
  __  __ _                               _____                               _____ _____  ______
 |  \/  (_)                             |  __ \                             |_   _|  __ \|  ____|
 | \  / |_ _ __ __ _  __ _  ___  _ __   | |__) | __ ___   ___ ___  ___ ___    | | | |  | | |__
 | |\/| | | '__/ _` |/ _` |/ _ \| '_ \  |  ___/ '__/ _ \ / __/ _ \/ __/ __|   | | | |  | |  __|
 | |  | | | | | (_| | (_| | (_) | | | | | |   | | | (_) | (_|  __/\__ \__ \  _| |_| |__| | |____
 |_|  |_|_|_|  \__,_|\__, |\___/|_| |_| |_|   |_|  \___/ \___\___||___/___/ |_____|_____/|______|
                      __/ |
                     |___/


Options:
  -V, --version            output the version number
  -h, --help               display help for command

Commands:
  deploy-file [options]    deploys an artifact to the target environment
  deploy-all [options]     deploys all artifacts to the target environment
  generate-file [options]  generates a process process artifact
  generate [options]       generates a project foundation
  help [command]           display help for command
```

**Deployment**

```bash
# deploy project to target env dev
npx @miragon/miranum-cli deploy -d . -t dev

# deploy project example-project to env prod
npx @miragon/miranum-cli deploy -d path/to/example-project -t dev
```

**Deploy single file**

```bash
# deploy project to target env dev
npx @miragon/miranum-cli deploy-file -f resources/my-process-automation-project/my-process.bpmn -t dev --type bpmn
```

**Generate new project**

```bash
npx @miragon/miranum-cli generate --name my-awesome-project --path .
```
npm package: @miragon/miranum-core
Description: **Features**
Latest version: 0.6.0

# miranum-core

**Features**

- Generates process artifacts and automation projects
- Defines a standard structure for automation projects
- Deploys artifacts to your digiwf instance

- [documentation](https://github.com/Miragon/miranum-ide/tree/main/docs)
- [examples](https://github.com/Miragon/miranum-ide-examples)

## Getting started

```
npm install @miragon/miranum-core
```

```typescript
import { createDigiwfLib } from "@miragon/miranum-core";
import { MiranumDeploymentPluginRest } from "./miranum-deployment-plugin-rest";

// init miranum-core
const digiwfLib = createDigiwfLib("1.0.0", "my-awesome-project", {
    "forms": "forms",
    "elementTemplates": "element-templates",
    "configs": "configs"
}, [new MiranumDeploymentPluginRest("rest", [
    {
        "name": "dev",
        "url": "http://localhost:8080"
    }
])]);

const myArtifact = {
    type: "bpmn",
    "project": "my-awesome-project",
    file: {
        name: "my-process",
        extension: "bpmn",
        content: "..."
    }
}; 
    
// deploy file
digiwfLib.deploy("dev", myArtifact)
    .then(success => console.log(success));

// generate new project
digiwfLib.initProject("my-awesome-project")
    .then(artifacts => console.log(artifacts));

// generate new file
digiwfLib.generateArtifact("my-process", "bpmn", "my-awesome-project")
    .then(artifact => console.log(artifact));
```

## More Information

Checkout our

- [documentation](https://github.com/Miragon/miranum-ide/tree/main/docs)
- [examples](https://github.com/Miragon/miranum-ide-examples)