Skip to content

chore:update terminal session documentation #578

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

chore:update terminal session documentation #578

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
24 changes: 24 additions & 0 deletions docs/terminal/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,30 @@ The terminal inherits your application's theme and font settings. Customize them

When the terminal is focused, application shortcuts are disabled to prevent conflicts with terminal commands. For example, `CTRL + C` sends SIGINT instead of copying.

### Sessions

Keep long-running shells alive and switch between them as needed.

What sessions enable:

* Multiple concurrent terminals: Create, name, and jump between sessions without losing shell state.
Copy link
Collaborator

@zhravan zhravan Dec 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Currently restricted to 3

* Auto-reconnect: The UI re-attaches to the last active session after page reloads or short disconnects.
Copy link
Collaborator

@zhravan zhravan Dec 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Right now we do not do auto-recoonect to last session, upon refresh, you would see new connection established.

This is a good point to note, we should consider this as an improvement, with flag control for how terminals should behave. Please consider this as enhancement.

This wont be applicable for current state of terminal implementation at least.

* Background execution: Commands keep running even if you close the tab or move to a different view.
* Crash-safe: If the frontend exits unexpectedly, you can reattach later and keep working.

Getting started:

1. Create a session: Opening the terminal automatically starts a session; use the session menu to spin up more.
2. Rename a session: Give each session a descriptive name (for example `deploy` or `logs`) from the session menu.
Copy link
Collaborator

@zhravan zhravan Dec 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This also is something we current dont support

3. Switch sessions: Select any existing session to attach instantly—scrollback and history stay intact per session.
4. Close a session: Exit the shell or use the session menu to terminate it when you're done.

Notes:

* Session history is preserved while the session remains active.
* Sessions stick to the current environment or VPS target.
* Idle sessions may be reclaimed automatically based on server policy.

## What's Coming Next

* Command sanitization and System protection against harmful commands
Expand Down
Loading