<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@keymanapp/kmc-package](./kmc-package.md) &gt; [KmpCompiler](./kmc-package.kmpcompiler.md) &gt; [run](./kmc-package.kmpcompiler.run.md)

## KmpCompiler.run() method

Compiles a .kps file to .kmp file. Returns an object containing binary artifacts on success. The files are passed in by name, and the compiler will use callbacks as passed to the [KmpCompiler.init()](./kmc-package.kmpcompiler.init.md) function to read any input files by disk.

**Signature:**

```typescript
run(inputFilename: string, outputFilename?: string): Promise<KmpCompilerResult>;
```

## Parameters

|  Parameter | Type | Description |
|  --- | --- | --- |
|  inputFilename | string |  |
|  outputFilename | string | _(Optional)_ |

**Returns:**

Promise&lt;[KmpCompilerResult](./kmc-package.kmpcompilerresult.md)<!-- -->&gt;

Binary artifacts on success, null on failure.