Skip to content

docs: add CLI usage section to README #7

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
laurapiro17 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add CLI usage section to README #7

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
11 changes: 11 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,17 @@ A lightweight web-based viewer for mass spectrometry data.
```bash
streamlit run app.py
```
## CLI Usage

After installing dependencies, you can use the command-line interface to open files directly:
```bash
toppview-lite start # start background server
toppview-lite your_file.mzML # open file directly
toppview-lite status # check server status
toppview-lite stop # stop server
```

The CLI maintains a background Streamlit server — after the initial startup, opening new files is nearly instant.

## Docker Deployment

Expand Down