Skip to content
Merged
Show file tree
Hide file tree
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
7 changes: 7 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,13 @@ All notable changes to this project are documented here. The format follows

## [Unreleased]

## [0.3.2] - 2026-07-28

### Fixed

- Updated the English and Korean installation instructions now that the npm
package is available.

## [0.3.1] - 2026-07-28

### Changed
Expand Down
19 changes: 9 additions & 10 deletions README.ko.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
**서버를 운영하는 사람을 위한 불멍.**

[![CI](https://github.com/seoulpro/embertop/actions/workflows/ci.yml/badge.svg)](https://github.com/seoulpro/embertop/actions/workflows/ci.yml)
[![npm](https://img.shields.io/npm/v/embertop.svg)](https://www.npmjs.com/package/embertop)
[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
[![Node](https://img.shields.io/badge/node-%E2%89%A522.13-brightgreen.svg)](package.json)

Expand All @@ -19,10 +20,8 @@ Embertop은 머신의 실시간 움직임을 모닥불로 바꿉니다. CPU 사
터미널에 오래 켜 두는 서버 불멍이라는 뜻입니다.

```bash
git clone https://github.com/seoulpro/embertop.git
cd embertop
npm ci
npm run cli
npm install --global embertop
embertop
```

## 불 읽는 법
Expand Down Expand Up @@ -69,22 +68,22 @@ Embertop은 CLI가 기본입니다. 터미널 UI가 제품 자체이고, 웹 대
| 웹 대시보드 | 같은 스트림의 브라우저 화면 | 백오피스 인증 뒤 |

CLI 실행 경로는 Node.js 내장 모듈만 사용하며 백그라운드 서비스를 띄우지
않습니다. 아직 npm에는 게시되지 않았습니다. 이후 예제에서는 읽기 쉽게
설치된 경우의 `embertop` 명령을 사용하며, 체크아웃에서 실행할 때는 이를
`npm run cli --`로 바꾸면 됩니다.
않습니다. npm 패키지를 전역 설치하면 이후 예제의 `embertop` 명령을 그대로
사용할 수 있습니다. 소스 체크아웃에서는 먼저 `npm ci`를 실행하고
`embertop` 대신 `npm run cli --`를 사용하십시오.

## 로컬 머신 보기

```bash
npm run cli
embertop
```

로그를 지정하지 않으면 시스템 활동만 표시합니다. 읽을 수 있는 접근 로그를
하나 이상 추가하면 새로 기록되는 요청이 불씨가 됩니다.

```bash
npm run cli -- --log /var/log/nginx/access.log
npm run cli -- -l /var/log/nginx/site-a.log -l /var/log/nginx/site-b.log
embertop --log /var/log/nginx/access.log
embertop -l /var/log/nginx/site-a.log -l /var/log/nginx/site-b.log
```

Nginx와 JSON 형식은 자동으로 판별합니다. Embertop이 시작한 *이후*에 기록된
Expand Down
19 changes: 9 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
**Ambient observability for people who run things.**

[![CI](https://github.com/seoulpro/embertop/actions/workflows/ci.yml/badge.svg)](https://github.com/seoulpro/embertop/actions/workflows/ci.yml)
[![npm](https://img.shields.io/npm/v/embertop.svg)](https://www.npmjs.com/package/embertop)
[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
[![Node](https://img.shields.io/badge/node-%E2%89%A522.13-brightgreen.svg)](package.json)

Expand All @@ -21,10 +22,8 @@ Embertop brings that feeling to a machine you look after. Its name pairs
`ember` with `top`, a nod to the terminal monitor.

```bash
git clone https://github.com/seoulpro/embertop.git
cd embertop
npm ci
npm run cli
npm install --global embertop
embertop
```

## Reading the fire
Expand Down Expand Up @@ -72,22 +71,22 @@ companion for wall displays and existing backoffices.
| Web dashboard | Optional browser view of the same stream. | Behind your backoffice auth |

The CLI execution path uses only Node.js built-ins and starts no background
service. The package is not yet published to npm. For readability, later
examples use `embertop` as if it were installed; from a checkout, replace it
with `npm run cli --`.
service. Install the npm package globally to use the `embertop` command in the
examples below. From a source checkout, run `npm ci` once and replace
`embertop` with `npm run cli --`.

## Watch a local machine

```bash
npm run cli
embertop
```

With no log configured, Embertop shows system activity only. Add one or more
readable access logs to turn newly appended requests into sparks:

```bash
npm run cli -- --log /var/log/nginx/access.log
npm run cli -- -l /var/log/nginx/site-a.log -l /var/log/nginx/site-b.log
embertop --log /var/log/nginx/access.log
embertop -l /var/log/nginx/site-a.log -l /var/log/nginx/site-b.log
```

Nginx and JSON formats are detected automatically. Only lines written *after*
Expand Down
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "embertop",
"version": "0.3.1",
"version": "0.3.2",
"description": "Ambient observability for people who run things: turns live server traffic into a campfire in your terminal.",
"license": "MIT",
"author": "Sumin Lim <lim@limsumin.com> (https://limsumin.com)",
Expand Down