Skip to content
Merged
Changes from all commits
Commits
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
44 changes: 23 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,22 +15,40 @@ You can also build entirely new agents in TypeScript with the Blink SDK.

![Blink Demo](https://docs-resources.blink.so/blink-demo.gif)

## Get Started

### Requirements

- Node.js 22+ or Bun
- Docker (the server needs it to deploy agents)

### Install and run the Blink server

```sh
npm install -g blink-server
blink-server
```

Open the Blink web UI in your browser and create your first agent. Alternatively, you may run the server [with Docker](https://blink.coder.com/docs/server/docker-deployment).

## Use Cases

- **Understanding complex codebases** - ask questions about how a repo works, how parts connect, or where to start when the code is unfamiliar.
- **Coding partner in Slack** - discuss ideas, open GitHub issues, or handle small coding tasks directly in Slack without breaking the conversation.
- **Customer support in shared channels** - let your customers ask technical questions in shared Slack channels and get answers backed by citations from your codebase and documentation.

- **And more** - Blink lets you build custom agents for any use case.

<p align="center">
<img src="./scripts/blink-diagram.png" alt="Blink Diagram" width="600px">
</p>

Many of the things you can do with Blink are also possible with ChatGPT, Claude Web, or Claude Code. Blink shines when you need to:
## Why Blink?

- Retain control of your data and infrastructure. Blink runs on your own servers, and agents can use any LLM provider: be it Amazon Bedrock, Google Vertex, or a self-hosted model.
- Centralize your conversations. Compared to Claude Code, all conversations are stored in a single database.
- Centralize access. Blink lets you define access controls to your agents in a single place.
- Fully control the source code of your agents. Blink is open source.
- **Retain control of your data and infrastructure.** Blink runs on your own servers, and agents can use any LLM provider: be it Amazon Bedrock, Google Vertex, or a self-hosted model.
- **Centralize your conversations.** Compared to Claude Code, all conversations are stored in a single database.
- **Centralize access.** Blink lets you define access controls to your agents in a single place.
- **Write code instead of configuring MCP and Skills.** With Blink you use TypeScript to build agents and add tools to them.

## Features

Expand All @@ -42,22 +60,6 @@ Many of the things you can do with Blink are also possible with ChatGPT, Claude
- **Docker-based deployment** - agents are deployed as Docker containers
- **User and organization management** - invite your team to use and collaborate on agents

## Get Started

### Requirements

- Node.js 22+ or Bun
- Docker (the server needs it to deploy agents)

### Install and run the Blink server

```sh
npm install -g blink-server
blink-server
```

Open the Blink web UI in your browser and create your first agent. Alternatively, you may run the server [with Docker](https://blink.coder.com/docs/server/docker-deployment).

## What's a Blink agent?

Agents are HTTP servers that respond to events. The Blink Server deploys them as Docker containers, routes messages from Slack/GitHub/web UI, and manages conversation state - your agent just defines how to respond.
Expand Down
Loading