Skip to content

Commit 245a3f2

Browse files
authored
chore: updating readme, adding terminalizer config (#41)
## Description <!-- Provide a brief description of your changes --> **Note:** PR titles should follow [Conventional Commits](https://www.conventionalcommits.org/) format (e.g., `feat(devbox): add support for custom env vars` or `fix(snapshot): resolve pagination issue`) as they are used for automatic release notes generation. ## Type of Change <!-- Mark the relevant option with an 'x' --> - [ ] Bug fix (non-breaking change which fixes an issue) - [ ] New feature (non-breaking change which adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) - [ ] Documentation update - [ ] Code refactoring - [ ] Performance improvement - [ ] Test updates ## Related Issues <!-- Link to related issues using #issue-number --> Closes # ## Changes Made <!-- Describe the changes in detail --> ## Testing <!-- Describe how you tested your changes --> - [ ] I have tested locally - [ ] I have added/updated tests - [ ] All existing tests pass ## Checklist - [ ] My code follows the code style of this project - [ ] I have performed a self-review of my own code - [ ] I have commented my code, particularly in hard-to-understand areas - [ ] I have updated the documentation accordingly - [ ] My changes generate no new warnings - [ ] I have added tests that prove my fix is effective or that my feature works - [ ] New and existing unit tests pass locally with my changes - [ ] Any dependent changes have been merged and published ## Screenshots (if applicable) <!-- Add screenshots to help explain your changes --> ## Additional Notes <!-- Any additional information that reviewers should know -->
1 parent 37f3cfd commit 245a3f2

2 files changed

Lines changed: 110 additions & 3 deletions

File tree

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
[![CI](https://github.com/runloopai/rl-cli/actions/workflows/ci.yml/badge.svg)](https://github.com/runloopai/rl-cli/actions/workflows/ci.yml)
55
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
66

7-
A beautiful CLI for managing Runloop built with Ink and TypeScript. Use it as an **interactive command-line application** with rich UI components, or as a **traditional CLI** for scripting and automation.
7+
An interactive CLI for interacting with the [Runloop.ai](https://runloop.ai) platform. Use it as an **interactive command-line application** with rich UI components, or as a **traditional CLI** for scripting and automation.
88

99
<p align="center">
1010
<img src="https://raw.githubusercontent.com/runloopai/rl-cli/main/misc/demo.gif" alt="Runloop CLI Demo" width="800">
@@ -27,8 +27,8 @@ rli devbox delete <devbox-id>
2727

2828
- ⚡ Fast and responsive with pagination
2929
- 📦 Manage devboxes, snapshots, and blueprints
30-
- 🚀 Execute commands in devboxes
31-
- 🎯 Organized command structure with aliases
30+
- 🚀 Execute commands, ssh, view logs in devboxes
31+
- 🎯 Traditional CLI with text, json, and yaml output modes.
3232
- 🤖 **Model Context Protocol (MCP) server for AI integration**
3333

3434
## Installation

misc/config.yml

Lines changed: 107 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,107 @@
1+
# Specify a command to be executed
2+
# like `/bin/bash -l`, `ls`, or any other commands
3+
# the default is bash for Linux
4+
# or powershell.exe for Windows
5+
command: rli
6+
7+
# Specify the current working directory path
8+
# the default is the current working directory path
9+
cwd: ~
10+
11+
# Export additional ENV variables
12+
env:
13+
recording: true
14+
15+
# Explicitly set the number of columns
16+
# or use `auto` to take the current
17+
# number of columns of your shell
18+
cols: auto
19+
20+
# Explicitly set the number of rows
21+
# or use `auto` to take the current
22+
# number of rows of your shell
23+
rows: auto
24+
25+
# Amount of times to repeat GIF
26+
# If value is -1, play once
27+
# If value is 0, loop indefinitely
28+
# If value is a positive number, loop n times
29+
repeat: 0
30+
31+
# Quality
32+
# 1 - 100
33+
quality: 100
34+
35+
# Delay between frames in ms
36+
# If the value is `auto` use the actual recording delays
37+
frameDelay: auto
38+
39+
# Maximum delay between frames in ms
40+
# Ignored if the `frameDelay` isn't set to `auto`
41+
# Set to `auto` to prevent limiting the max idle time
42+
maxIdleTime: 1000
43+
44+
# The surrounding frame box
45+
# The `type` can be null, window, floating, or solid`
46+
# To hide the title use the value null
47+
# Don't forget to add a backgroundColor style with a null as type
48+
frameBox:
49+
type: floating
50+
title: rli
51+
style:
52+
border: 0px black solid
53+
# boxShadow: none
54+
# margin: 0px
55+
56+
# Add a watermark image to the rendered gif
57+
# You need to specify an absolute path for
58+
# the image on your machine or a URL, and you can also
59+
# add your own CSS styles
60+
watermark:
61+
imagePath: null
62+
style:
63+
position: absolute
64+
right: 15px
65+
bottom: 15px
66+
width: 100px
67+
opacity: 0.9
68+
69+
# Cursor style can be one of
70+
# `block`, `underline`, or `bar`
71+
cursorStyle: block
72+
73+
# Font family
74+
# You can use any font that is installed on your machine
75+
# in CSS-like syntax
76+
fontFamily: "Monaco, Lucida Console, Ubuntu Mono, Monospace"
77+
78+
# The size of the font
79+
fontSize: 12
80+
81+
# The height of lines
82+
lineHeight: 1
83+
84+
# The spacing between letters
85+
letterSpacing: 0
86+
87+
# Theme
88+
theme:
89+
background: "#232628"
90+
foreground: "#afafaf"
91+
cursor: "#c7c7c7"
92+
black: "#232628"
93+
red: "#fc4384"
94+
green: "#b3e33b"
95+
yellow: "#ffa727"
96+
blue: "#75dff2"
97+
magenta: "#ae89fe"
98+
cyan: "#708387"
99+
white: "#d5d5d0"
100+
brightBlack: "#626566"
101+
brightRed: "#ff7fac"
102+
brightGreen: "#c8ed71"
103+
brightYellow: "#ebdf86"
104+
brightBlue: "#75dff2"
105+
brightMagenta: "#ae89fe"
106+
brightCyan: "#b1c6ca"
107+
brightWhite: "#f9f9f4"

0 commit comments

Comments
 (0)