Skip to content
runyte About Features Screenshots Install Docs Plugins Performance GitHub ↗
[building from a clone] [RO]
Contents
  1. Overview
  2. Overview
    1. What Runyte does
    2. Runyte and Helix
  3. Install and run
    1. Install and update with curl
    2. Manual download and source installation
    3. Building from a clone
    4. Windows support
    5. Starting Runyte
  4. The screen
    1. Screen layout
    2. Global status line
    3. Interaction line
    4. Notifications
    5. Help, hints, and the tutorial
    6. Mouse
    7. Jump history
    8. Contextual actions (`Tab`)
  5. Key bindings
    1. Editing
    2. Insert and Replace modes
    3. Search
    4. Layout and whitespace display
    5. Text objects
    6. Surround editing
    7. Structural syntax
    8. Macros
  6. Files and buffers
    1. File and buffer keys
    2. Opening files and links
    3. Opening binary files
    4. Saving and closing
    5. The Finder
    6. Buffer list
    7. Directory buffers
    8. Directory tree sidebar
    9. Files changed outside Runyte
    10. Comparing two files
    11. Shell pipes
    12. System clipboard
  7. Panes
    1. Pane keys
    2. Splitting
    3. Fast pane keys
    4. Equalizing
    5. Zen and fullscreen
  8. Terminals
    1. Starting a terminal
    2. Terminal modes
    3. Terminal keys
    4. Moving text in and out
    5. Managing terminal sessions
    6. Emulation and limits
  9. Git
    1. Git keys
    2. Status line and gutter
    3. Automatic refresh
    4. Changed files, staging, and committing
    5. Diffs
    6. Branches
    7. Worktrees
    8. Committed comparisons
    9. History, search, and blame
    10. Stashes
    11. Reviewed merges and conflicts
    12. Fetch, pull, and push
    13. Background operation and failures
  10. Language support
    1. Syntax highlighting
    2. Rendered Markdown
    3. Language servers
    4. Language features
  11. Workspaces and persistent sessions
    1. Starting a workspace
    2. Editor mode
    3. Quitting and detaching
    4. Session keys and commands
    5. The session manager
    6. Session and destination navigation
    7. Managing sessions from the command line
    8. External editor requests (`--wait`)
    9. Runtime files and discovery
    10. Change the shell directory on exit
  12. Commands
    1. The command palette
    2. Command list
  13. Plugins
    1. Using plugins
    2. What plugins can do
    3. Example applications
  14. Agent access to workspace context
    1. Setting it up
    2. Granting and checking access
    3. What a grant covers
    4. How agents use it
    5. Terminal reads
    6. Buffer edits
    7. Terminal proposals
  15. Diagnostics and logging
    1. Reading the log
    2. Levels and startup controls
    3. Who owns the log
    4. What is recorded, and what never is
    5. Bounds
  16. Configuration
    1. Where the configuration lives
    2. What the file looks like
    3. Changing settings in the editor
    4. Indentation overrides
    5. Editing the file and reloading
    6. Settings reference
    7. Configuration recipes
    8. Setting details
    9. Checking service health
  17. Custom key bindings
    1. Quick examples
    2. Changing the leader and window keys
    3. Moving default bindings
    4. Binding actions
    5. Key binding recipes
    6. How bindings are resolved
    7. Action sequences
    8. Limits and errors
    9. Bindable action reference
  18. Themes
    1. Choosing a theme
    2. Built-in themes
    3. Writing a custom theme
    4. Colour values
    5. Terminal ANSI colours
    6. Theme colour reference
    7. Syntax colours
    8. Derived colours
  19. Project layout
  20. License

User guide / Install and run

Building from a clone

Development reference · View source

./build.sh --release
./target/release/runyte README.md

build.sh wraps cargo build --bins and forwards any extra arguments.

Install from the clone with Cargo:

cargo install --path .

During development:

./build.sh
cargo run -- src/main.rs
cargo test
← Manual download and source installation Windows support →
NOR runyte.com/docs/user-guide/install-and-run/building-from-a-clone/ [read-only] GitHub ↗

    ↑ ↓ select · Enter open · Esc close

    Press keys in sequence. Start a command with :, then press Enter. You can also click or tap each action.

    These controls navigate the website. Editor shortcuts · Full user guide

    Runyte in action · Open video

    Runyte closed. You can close this tab.

    Your browser kept the tab open.

    :

      Tab complete · ↑ ↓ select · Enter run