Skip to content

docs: add installation instructions for local development #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
alxbello merged 2 commits into from
Apr 23, 2026
Merged

docs: add installation instructions for local development #2

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7014a51
docs: add installation instructions for local development
alxbello Apr 23, 2026
68ed0e0
docs: use npm link for local installation workflow
alxbello Apr 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,26 @@

A TypeScript framework for defining [Kiro](https://kiro.dev) agentic configurations using CDK-style constructs. Enables composability, reusability, and type safety for AI agent configuration.

## Installation

> **Note:** This package is not yet published to npm. Install from source:

```bash
git clone https://github.com/kirodotdev-labs/constructs.git
cd constructs
npm install
npm run build
cd packages/kiro-constructs
npm link
```

Then in your project, link the package and install the required `constructs` peer dependency:

```bash
npm link @kiro/constructs
npm install constructs
```

## Quick Start

```typescript
Expand Down
Loading