salvetron

KO | EN

gitlite — search

#mysql #css #cloud-native #data-science #react #chatbot #reactjs #php #command-line #containers

(★ 9)

No description available.

파일 탐색기

ZIP 다운로드

- CLAUDE.md
- - android-build.yml
  - ios-build.yml
  - labeler.yml
  - lint.yml
  - publish-react-native.yml
  - publish-root.yml
  - publish-types.yml
  - unit-tests.yml
- CODEOWNERS
- labeler.yml
- banner.png
- launch_icon.png
- screenshot-1.png
- salvetron.tsx
- - .watchmanconfig
  - .yarnrc.yml
  - babel.config.js
  - LICENSE
  - nitro.json
  - NitroSalvetron.podspec
  - package.json
  - react-native.config.js
  - README.md
  - tsconfig.json
  - yarn.lock
- - package.json
  - tsconfig.json
- mouse-debug.mjs
- salvetron-sim.mjs
- - ws-server.ts
- - types.ts
- app.tsx
.gitignore
.yarnrc.yml
package.json
README.md
tsconfig.json
yarn.lock

# CDN으로 사용하기

jsDelivr

jsDelivr는 공개 GitHub 리포지토리를 별도 설정 없이 CDN으로 즉시 서빙합니다. 버전과 파일을 고르면 웹페이지에 바로 붙일 수 있는 링크와 예시 코드가 만들어집니다.

버전

파일

링크

예시

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<h1 align="center">Salvetron</h1>

Real-time terminal UI debugger for React Native

---

Salvetron is a real-time debugging tool for React Native developers, delivered as a terminal UI (TUI). The Salvetron CLI runs a WebSocket server in your terminal and renders incoming telemetry — JS logs, native logs, network traffic, and live performance metrics — from your running app. Your app streams that telemetry using the companion SDK, `@salve-software/salvetron-react-native`.

## Features

- **Dashboard** - Live performance overview: UI/JS FPS, memory and CPU usage, with sparkline history
- **JS Logs** - Stream JavaScript console logs with level filtering (debug, info, warn, error) and an expandable detail panel for metadata
- **Network Inspector** - Inspect HTTP requests and responses: method, status, duration, headers, and pretty-printed bodies
- **Native Logs** - View iOS and Android platform logs in real-time, with source tags
- **Keyboard-driven TUI** - Navigate panels and lists entirely from the keyboard; no GUI required
- **Zero-config WebSocket server** - Starts on port 8765 by default (override with `SALVETRON_PORT`)

## Screenshots

## Architecture

Salvetron has two parts:

```
┌──────────────────────────┐        WebSocket          ┌──────────────────────────┐
│     React Native App      │ ───────────────────────▶ │       Salvetron CLI      │
│ @salve-software/          │        port 8765          │  (terminal UI debugger)  │
│   salvetron-react-native  │                           │                          │
└──────────────────────────┘                            └──────────────────────────┘
         │                                                        │
         ├── JS Console Logs                                      ├── Dashboard (FPS/CPU/memory)
         ├── Native Logs (iOS/Android)                            ├── JS Logs viewer
         ├── Network Requests/Responses                           ├── Network Inspector
         └── Performance Metrics                                  └── Native Logs viewer
```

1. **Salvetron CLI** (`salvetron`): an Ink-based terminal UI that runs a WebSocket server and renders telemetry from connected apps.

2. **salvetron-react-native** (SDK): A React Native package built with Nitro Modules that captures logs, network activity, and performance metrics and streams them to the CLI.

## Installation

### Requirements

| Component | Requirement |
|-----------|-------------|
| Salvetron CLI | Node.js 18+ |
| React Native SDK | React Native 0.73+ |
| Xcode | 15+ (for iOS development) |
| Android Studio | Latest (for Android development) |

### Running the Salvetron CLI

1. Clone the repository:
   ```bash
   git clone https://github.com/Salve-Software/salvetron.git
   cd salvetron
   yarn install
   ```

2. Start the CLI:
   ```bash
   yarn dev          # starts the Salvetron CLI (Ink TUI) on port 8765
   ```

Or, once published:
   ```bash
   npx salvetron
   ```

Override the port with the `SALVETRON_PORT` environment variable:
   ```bash
   SALVETRON_PORT=9000 yarn dev
   ```

### Installing React Native SDK

1. Install the package in your React Native project:

```bash
   npm install @salve-software/salvetron-react-native

# Using yarn
   yarn add @salve-software/salvetron-react-native
   ```

2. For iOS, install pods:
   ```bash
   cd ios && pod install && cd ..
   ```

3. For Android, the package will auto-link. Run a gradle sync if needed.

## Usage

### Starting the Salvetron CLI

Run `yarn dev` (or `npx salvetron`) in your terminal. The CLI starts a WebSocket server on port **8765** and shows the Dashboard. Use the tab bar / keyboard shortcuts shown in the status bar to switch between Dashboard, JS Logs, Network, and Native Logs. Connected device info appears in the header once your app connects.

### Connecting from React Native

Add the following code to your React Native app's entry point (e.g., `App.tsx` or `index.js`):

```typescript
import Salvetron from '@salve-software/salvetron-react-native';

// Connect only in development mode
if (__DEV__) {
  Salvetron.connect({
    host: '192.168.1.100', // Your Mac's IP address
    port: 8765,
    enableNetworkCapture: true,
    onConnect: () => console.log('Connected to Salvetron!'),
    onDisconnect: () => console.log('Disconnected from Salvetron'),
    onError: (error) => console.error('Salvetron error:', error),
  });
}
```

> **Tip**: Use `localhost` when running on iOS Simulator, or your Mac's local IP address for physical devices.

### API Reference

#### `Salvetron.connect(config?)`

Establishes a WebSocket connection to the Salvetron CLI.

```typescript
interface SalvetronConfig {
  host?: string;              // Default: 'localhost'
  port?: number;              // Default: 8765
  enableNetworkCapture?: boolean;  // Default: true
  ignoredUrls?: RegExp[];     // URL patterns to ignore
  onConnect?: () => void;
  onDisconnect?: () => void;
  onError?: (error: Error) => void;
}
```

#### `Salvetron.disconnect()`

Closes the WebSocket connection.

```typescript
Salvetron.disconnect();
```

#### `Salvetron.isConnected()`

Returns the current connection status.

```typescript
const connected = Salvetron.isConnected(); // boolean
```

#### Logging Methods

```typescript
// Send logs with different levels
Salvetron.log('General log message');
Salvetron.debug('Debug information', { userId: 123 });
Salvetron.info('Informational message');
Salvetron.warn('Warning message');
Salvetron.error('Error message', { stack: error.stack });
```

All logging methods accept an optional metadata object as the second parameter.

## Troubleshooting

### Connection Issues

**Problem**: App can't connect to the Salvetron CLI

**Solutions**:
1. Ensure the Salvetron CLI is running (`yarn dev` / `npx salvetron`)
2. Check that both devices are on the same network
3. Verify the IP address is correct (use `ifconfig` to find your machine's IP)
4. Check if port 8765 is not blocked by firewall
5. For iOS Simulator, use `localhost` instead of IP address

### Network Requests Not Showing

**Problem**: HTTP requests are not appearing in the Network tab

**Solutions**:
1. Ensure `enableNetworkCapture: true` is set in the config
2. Check if the URL isn't in the `ignoredUrls` list
3. Default ignored URLs include Metro bundler (port 8081) and hot reload endpoints

### Logs Not Appearing

**Problem**: Console logs are not showing in the Salvetron CLI

**Solutions**:
1. Verify the connection is established (`Salvetron.isConnected()`)
2. Ensure you're running in development mode (`__DEV__ === true`)
3. Confirm the CLI shows your device in the header

### High Memory Usage

**Problem**: The Salvetron CLI process using too much memory

**Solutions**:
1. Clear logs periodically from the JS Logs / Native Logs panels
2. Reduce the number of connected devices
3. Filter out verbose logs at the source

## Contributing

We welcome contributions! Here's how you can help:

### Getting Started

1. Fork the repository
2. Clone your fork:
   ```bash
   git clone https://github.com/your-username/salvetron.git
   ```
3. Create a new branch:
   ```bash
   git checkout -b feature/your-feature-name
   ```

### Branch Naming Convention

- `feature/` - New features
- `fix/` - Bug fixes
- `docs/` - Documentation updates
- `refactor/` - Code refactoring
- `test/` - Adding or updating tests

### Commit Message Format

Follow conventional commits:
```
type(scope): description

Examples:
feat(sdk): add custom log levels support
fix(app): resolve memory leak in log viewer
docs(readme): update installation instructions
```

### Pull Request Process

1. Ensure your code follows the existing style
2. Update documentation if needed
3. Test your changes thoroughly:
   - For Salvetron CLI: run `yarn dev` and verify with the simulator (`yarn sim`)
   - For SDK: Test with the example app
4. Create a Pull Request with a clear description

### Code Style Guidelines

**salvetron (CLI, TypeScript / Ink)**:
- Use TypeScript for all source files
- Keep modules organized under `src/modules/<feature>` and shared UI under `src/shared`
- Run `yarn typecheck` before opening a PR

**salvetron-react-native (SDK, TypeScript)**:
- Use TypeScript for all source files
- Follow existing patterns in the codebase
- Document public APIs with JSDoc comments

### Running the Example App

```bash
cd packages/salvetron-react-native/example
yarn install
cd ios && pod install && cd ..
yarn ios  # or yarn android
```

## License

This project is licensed under the MIT License - see below for details:

```
MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
```

---

Made by Salve Software

salvetron

파일 탐색기

# CDN으로 사용하기

Was this content helpful?

Recent Feedback

Download README