8000 docs: describe the one-click default install and list the newer open PRs by adeelahmad · Pull Request #335 · adeelahmad/lense · GitHub
[go: up one dir, main page]
Skip to content

docs: describe the one-click default install and list the newer open PRs #335

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

Merged
adeelahmad merged 1 commit into from
Oct 10, 2026
Merged

docs: describe the one-click default install and list the newer open PRs #335

Show file tree
Hide file tree
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
18 changes: 11 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,13 @@ cost-aware.
curl -fsSL https://raw.githubusercontent.com/adeelahmad/lense/main/install.sh | sh
```

That one line is all: it opens an installer in your browser that checks the computer, asks how Lens should run (in
Docker or a [microsandbox](docs/microsandbox.md) microVM), the AI model and its key and any extras, then installs
what's missing (Docker included), starts Lens and opens its setup page
([details](docs/get-started.md#the-web-installer)). Run it again to update. On Windows, run
`irm https://raw.githubusercontent.com/adeelahmad/lense/main/install.ps1 | iex` in PowerShell; or skip the terminal and
double-click the launcher for your system from the [latest release](https://github.com/adeelahmad/lense/releases/latest).
That one line is all: it opens an installer in your browser that checks the computer, then either installs with the
defaults in one click (with a model server it finds on the computer) or asks how Lens should run (in Docker or a
[microsandbox](docs/microsandbox.md) microVM), the AI model and its key and any extras. Either way it installs what's
missing (Docker included), starts Lens and opens its setup page ([details](docs/get-started.md#the-web-installer)).
Run it again to update. On Windows, run `irm https://raw.githubusercontent.com/adeelahmad/lense/main/install.ps1 | iex`
in PowerShell; or skip the terminal and double-click the launcher for your system from the
[latest release](https://github.com/adeelahmad/lense/releases/latest).
[Deployment](docs/deployment.md) covers servers and Cloudron; there are also packages for
[Synology](packaging/synology/README.md), [QNAP](packaging/qnap/README.md) and [Proxmox](proxmox/README.md).

Expand Down Expand Up @@ -135,7 +136,10 @@ These are open pull requests, not yet part of Lens:
([#287](https://github.com/adeelahmad/lense/pull/287)), without Matterbridge; and the assistant's own email address,
over IMAP and SMTP ([#314](https://github.com/adeelahmad/lense/pull/314)).
- **Assistant safety:** running MCP servers that are programs (stdio) in a sandbox
([#304](https://github.com/adeelahmad/lense/pull/304)).
([#304](https://github.com/adeelahmad/lense/pull/304)); flagging third-party text that reads like instructions to an
AI ([#329](https://github.com/adeelahmad/lense/pull/329)); and asking before the browser opens or types what the
assistant wrote after reading a page ([#333](https://github.com/adeelahmad/lense/pull/333)).
- **Cloud model presets** in Settings and the setup wizard ([#334](https://github.com/adeelahmad/lense/pull/334)).
- **Search:** a Similar tab, and similar content for text selected anywhere
([#307](https://github.com/adeelahmad/lense/pull/307)); NSFW pictures classified by a local model, per namespace
([#306](https://github.com/adeelahmad/lense/pull/306)).
Expand Down
3 changes: 2 additions & 1 deletion docs/get-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,8 @@ On a first install run at a terminal (on Linux or a Mac with Python 3.8 or later
above opens an installer in your browser instead of asking anything in the terminal:

1. **This computer**: the system, memory, free disk, whether Docker is there and running, and whether microsandbox can
run.
run. On a first install, **Install with the defaults** skips the next steps: it picks a model server it finds on
the computer, if there is one, and installs straight away. **Choose options** goes through them.
2. **How it runs**: Docker or [microsandbox](microsandbox.md), the full or lean edition (lean is picked on a computer
with less than 4 GB of memory, such as a Raspberry Pi), the folder, the port, and whether other devices on the
network may reach it. It lists what it will install; when that needs administrator rights, it asks for your
Expand Down
Loading
0