---
title: CLI launcher API
description: Generated public TypeScript reference for relkit.
search:
  exclude: true
sidebar:
  icon: braces
---

{/* Generated by apps/docs/scripts/generate.ts. Do not edit. */}

For configuration and examples, read [automation](/docs/modules/cli/automation).

## Public imports

- `relkit` — 2 exports

## All exported APIs

Names link to their complete contracts. Re-exports share their original contract; legacy exports keep their separate identity. Examples link to the API's inline sample, a maintained repository usage, or the shared module walkthrough.

| API                                                     | Kind  | Import from | Example                                        |
| ------------------------------------------------------- | ----- | ----------- | ---------------------------------------------- |
| [main](/docs/api/relkit#main)                           | Value | `relkit`    | [Module example](/docs/modules/cli/automation) |
| [resolveProjectCli](/docs/api/relkit#resolveprojectcli) | Value | `relkit`    | [Module example](/docs/modules/cli/automation) |

## `index.ts`

Lightweight launcher: create directly, or execute the compatible project-owned CLI.

### main

Launches one selected entry under Bun, preserving the child's terminal output.

**Signature**

```ts
declare const main: (argv?: readonly string[], cwd?: string) => Promise<number>;
```

[Source](https://github.com/rel-kit/relkit/blob/main/packages/relkit/src/index.ts#L48)

### resolveProjectCli

Resolves only the installed CLI declared by the nearest project manifest.

**Signature**

```ts
declare const resolveProjectCli: (cwd: string) => string;
```

[Source](https://github.com/rel-kit/relkit/blob/main/packages/relkit/src/index.ts#L15)
