conwnet · conwnet · Sep 20, 2026 · Sep 15, 2026 · Sep 16, 2026 · Sep 17, 2026
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -10,6 +10,9 @@ on:
 
 jobs:
   build:
+    permissions:
+      contents: read
+
     strategy:
       matrix:
         os: [macos-14]
@@ -19,6 +22,8 @@ jobs:
 
     steps:
       - uses: actions/checkout@v4
+        with:
+          persist-credentials: false
       - name: Use Node.js ${{ matrix.node-version }}
         uses: actions/setup-node@v4
         with:
@@ -28,5 +33,12 @@ jobs:
       - run: npm install
       - run: npm run eslint
       - run: npm run build
-      - uses: microsoft/playwright-github-action@v1
-      - run: npm run test:ci
+        env:
+          GITHUB_API_PREFIX: http://localhost:8080/api/github
+      - name: Install snapshot test dependencies
+        working-directory: tests
+        run: npm ci && npx playwright install --with-deps
+      - name: Run snapshot tests
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: npx start-server-and-test watch:dev-server http://localhost:8080 "env -u GITHUB_TOKEN npm --prefix tests test"
diff --git a/.github/workflows/test-wtih-vscode-build.yml b/.github/workflows/test-wtih-vscode-build.yml
@@ -37,5 +37,12 @@ jobs:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         run: npm run build
       - run: npm run link && npm run build
-      - uses: microsoft/playwright-github-action@v1
-      - run: npm run test:ci
+        env:
+          GITHUB_API_PREFIX: http://localhost:8080/api/github
+      - name: Install snapshot test dependencies
+        working-directory: tests
+        run: npm ci && npx playwright install --with-deps
+      - name: Run snapshot tests
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: npx start-server-and-test watch:dev-server http://localhost:8080 "env -u GITHUB_TOKEN npm --prefix tests test"
diff --git a/.gitignore b/.gitignore
@@ -4,3 +4,4 @@ dist
 out
 node_modules
 .worktrees/
+tests/__tests__/__image_snapshots__/__diff_output__/
diff --git a/README.md b/README.md
@@ -1,198 +1,67 @@
-![GitHub1s](https://raw.githubusercontent.com/conwnet/github1s/master/resources/images/logo.svg)
+![GitHub1s](resources/images/logo.svg)
 
-# github1s
+# GitHub1s
 
-One second to read GitHub code with VS Code.
+GitHub1s is a browser-based code explorer built on VS Code. Browse files, search code, and review changes without cloning a repository. Connect your preferred model to the built-in AI chat for help understanding the code.
 
-## Usage
+**[🌐 Try it now](https://github1s.com/conwnet/github1s)** · [📖 Usage guide](docs/usage.md) · [🔮 AI setup](docs/ai.md#configure-a-model)
 
-Just add `1s` after `github` and press `Enter` in the browser address bar for any repository you want to read.
+## 🚀 Quick start
 
-For example, try it on the VS Code repo:
+Add **`1s` after `github`** in a repository URL:
 
-[https://github1s.com/microsoft/vscode](https://github1s.com/microsoft/vscode)
-
-![VS Code - GitHub1s](https://raw.githubusercontent.com/conwnet/github1s/master/resources/images/vs-code-github1s.png)
-
-You can also use [https://gitlab1s.com](https://gitlab1s.com) or [https://npmjs1s.com](https://npmjs1s.com) in the same way.
-
-For browser extensions, see [Third-party Related Projects](https://github.com/conwnet/github1s#third-party-related-projects).
-
-Or save the following code snippet as a bookmarklet, you can use it to quickly switch between github.com and github1s.com (GitHub markdown doesn't allow js links, so just copy it into a bookmark).
-
-```
-javascript: window.location.href = window.location.href.replace(/github(1s)?.com/, function(match, p1) { return p1 ? 'github.com' : 'github1s.com' })
+```text
+https://github.com/microsoft/vscode
+        ↓
+https://github1s.com/microsoft/vscode
 ```
 
-### Develop in the cloud
-
-To edit files, run Docker containers, create pull requests and more, click the "Develop your project on [Gitpod](https://www.gitpod.io)" button in the status bar. You can also open the Command Palette (default shortcut `Ctrl+Shift+P`) and choose `GitHub1s: Edit files in Gitpod`.
-
-![Gitpod Status Bar](https://raw.githubusercontent.com/conwnet/github1s/master/resources/images/gitpod-statusbar.png)
-
-## Documentation
-
-- [How it works](https://github.com/conwnet/github1s/blob/master/docs/guide.md)
-- [Roadmap](https://github.com/conwnet/github1s/projects/1)
-
-## Enabling Private Repositories
-
-If you want to view non-public repositories, you need to add an OAuth token. The token is stored only in your browser, and only send to GitHub when fetching your repository's files. Click on the icon near the bottom of the left-hand row of icons, and the dialog box will prompt you for it, and even take you to your GitHub settings page to generate one, if needed.
-
-<img height="500px" src="https://raw.githubusercontent.com/conwnet/github1s/master/resources/images/auth-token.png" />
-
-## Screenshots
-
-![VS Code - GitHub1s](https://raw.githubusercontent.com/conwnet/github1s/master/resources/images/GitHub1sDemo1.gif)
-
-![VS Code - GitHub1s](https://raw.githubusercontent.com/conwnet/github1s/master/resources/images/demo.png)
-
-## Development
-
-### Cloud-based development
-
-You can start an online development environment with [Gitpod](https://www.gitpod.io) by clicking the following button:
-
-[![Gitpod ready-to-code](https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/conwnet/github1s)
-
-### Local development
-
-```bash
-git clone git@github.com:conwnet/github1s.git
-cd github1s
-npm install
-npm run watch
-# The cli will automatically open http://localhost:8080 once the build is completed.
-# You can visit http://localhost:8080/conwnet/github1s if it doesn't.
-```
-
-#### Local development with full VS Code build
-
-You need [these prerequisites (the same ones as for VS Code)](https://github.com/microsoft/vscode/wiki/How-to-Contribute#prerequisites) for development with full VS Code build.
-Please make sure you could build VS Code locally before the watch mode.
-
-To verify the build:
-
-```bash
-cd github1s
-npm run build:vscode
-```
-
-After the initial successful build, you could use the watch mode:
-
-```bash
-cd github1s
-npm install
-npm run watch-with-vscode
-# The cli will automatically open http://localhost:8080 once the build is completed.
-# You can visit http://localhost:8080/conwnet/github1s if it doesn't.
-```
-
-### ... or ... VS Code + Docker Development
-
-You can use the VS Code plugin [Remote-Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) `Dev Container` to use a Docker container as a development environment.
-
-1. Install the Remote-Containers plugin in VS Code & Docker
-2. Open the Command Palette (default shortcut `Ctrl+Shift+P`) and choose `Remote-Containers: Clone Repository in Container Volume...`
-3. Enter the repo, in this case `https://github.com/conwnet/github1s.git` or your forked repo
-4. Pick either, `Create a unique volume` or `Create a new volume`
-
-   - Now VS Code will create the docker container and connect to the new container so you can use this as a fully setup environment!
-
-5. Open a new VS Code Terminal, then you can run the `npm install` commands listed above.
-
-```bash
-npm install
-npm run watch
-# The cli will automatically open http://localhost:8080 once the build is completed.
-# You can visit http://localhost:8080/conwnet/github1s if it doesn't.
-```
-
-### Format all codes
-
-```bash
-npm run format
-```
-
-It uses `prettier` to format all possible codes.
-
-## Build
-
-```bash
-npm install
-npm run build
-```
-
-## Feedback
-
-- If something is not working, [create an issue](https://github.com/conwnet/github1s/issues/new)
-
-## Sponsors
-
-The continued development and maintenance of GitHub1s is made possible by these generous sponsors:
+Public repositories can be browsed **without signing in**, subject to the upstream services' access and rate limits.
 
-<table><tbody><tr>
-<td><a href="https://sourcegraph.com/">
-<img height="40px" src="https://raw.githubusercontent.com/conwnet/github1s/master/resources/images/sourcegraph-logo.svg">
-</a></td>
-</tr></tbody></table>
+![A repository open in GitHub1s, with the file explorer and README preview](resources/images/demo.png)
 
-## Partners
+You can also browse GitLab repositories at [gitlab1s.com](https://gitlab1s.com) and published npm packages at [npmjs1s.com](https://npmjs1s.com). See the [usage guide](docs/usage.md) for URL formats, authentication, and navigation.
 
-We are partnered with [OSS Insight](https://ossinsight.io/?utm_source=github1s&utm_medium=github&utm_campaign=ghtrending) to get the Trending Repositories & some more Interesting Analytics. [OSS Insight](https://ossinsight.io/?utm_source=github1s&utm_medium=github&utm_campaign=ghtrending) provides deep insights into GitHub repos, developers, and curated repo lists from billions of GitHub events. It’s built with [TiDB Cloud](https://www.pingcap.com/tidb-cloud/?utm_source=github1s&utm_medium=github&utm_campaign=ghtrending).
+## ✨ Features
 
-<table><tbody><tr>
-<td><a href="https://ossinsight.io/?utm_source=github1s&utm_medium=github&utm_campaign=ghtrending">
-<img height="40px" src="./resources/images/ossinsight-brand-dark.png">
-</a></td>
-</tr></tbody></table>
+- **Explore a project.** Browse directories, find files, and search code in a familiar VS Code interface.
+- **Trace a change.** Switch branches or tags, inspect commits and file history, and review pull or merge request diffs on GitHub and GitLab.
+- **Understand complex code.** Ask GitHub1s AI about a file or selection, then follow up on implementation details.
+- **Access private repositories.** Connect your GitHub or GitLab account, or supply an access token with the necessary permissions.
 
-## Maintainers! :blush:
+Remote repositories are **read-only**. Search and code navigation depend on the repository platform and available upstream services; see [capabilities and limits](docs/usage.md#capabilities-and-limits).
 
-<table>
-  <tbody><tr>
-    <td align="center"><a href="https://github.com/conwnet"><img alt="" src="https://avatars.githubusercontent.com/conwnet" width="100px;"><br><sub><b>netcon</b></sub></a><br><a href="https://github.com/conwnet/github1s/commits?author=conwnet" title="Code">💻 🖋</a></td> </a></td>
-    <td align="center"><a href="https://github.com/xcv58"><img alt="" src="https://avatars.githubusercontent.com/xcv58" width="100px;"><br><sub><b>xcv58</b></sub></a><br><a href="https://github.com/conwnet/github1s/commits?author=xcv58" title="Code">💻 🖋</a></td></a></td>
-    <td align="center"><a href="https://github.com/Siddhant-K-code"><img alt="" src="https://avatars.githubusercontent.com/Siddhant-K-code" width="100px;"><br><sub><b>Siddhant Khare</b></sub></a><br><a href="https://github.com/conwnet/github1s/commits?author=Siddhant-K-code" title="Code">💻 🖋</a></td> </a></td>
-  </tr>
-</tbody></table>
+## 🤖 GitHub1s AI
 
-## Stargazers over time
+Get a repository overview, explain a file or selection, and ask follow-up questions. The assistant can look up relevant code as you chat.
 
-[![Stargazers over time](https://api.star-history.com/svg?repos=conwnet/github1s&type=Date)](https://star-history.com/#conwnet/github1s&Date)
+Click **Toggle Secondary Side Bar** in the layout controls at the top of GitHub1s to open the AI panel.
 
-<details>
-<summary>Third-party Related Projects</summary>
-<br>
+Use a **model endpoint that accepts browser requests**. Messages and code context are sent to the selected endpoint. See the [AI guide](docs/ai.md) for configuration and data handling.
 
-### Chrome Extensions
+## 📚 Documentation
 
-- [Repositree](https://chrome.google.com/webstore/detail/repositree/lafjldoccjnjlcmdhmniholdpjkbgajo) ([chouglesaud/repositree](https://github.com/chouglesaud/repositree))
-- [github-code-viewer](https://chrome.google.com/webstore/detail/github-code-viewer/ecddapgifccgblebfibdgkagfbdagjfn) ([febaoshan/edge-extensions-github-code-viewer](https://github.com/febaoshan/edge-extensions-github-code-viewer))
-- Github1s Extension ([Darkempire78/GitHub1s-Extension](https://github.com/Darkempire78/GitHub1s-Extension))
-- [Github Web IDE](https://chrome.google.com/webstore/detail/adjiklnjodbiaioggfpbpkhbfcnhgkfe) ([zvizvi/Github-Web-IDE](https://github.com/zvizvi/Github-Web-IDE))
-- [shortcut to github1s](https://chrome.google.com/webstore/detail/shortcut-to-github1s/gfcdbodapcbfckbfpmgeldfkkgjknceo) ([katsuhisa91/github1s-shortcut](https://github.com/katsuhisa91/github1s-shortcut))
-- [Github1s Shortut - Open source](https://github.com/Fauzdar1/Github1s)
-- [⚡️ 1s to GitHub1s!](https://github.com/holazz/webext-github1s)
-- [github1s Google Chrome Extensions](https://github.com/Lonely-Mr-zhang/github_1s_vscode)
+| Guide                                | What you will find                                      |
+| ------------------------------------ | ------------------------------------------------------- |
+| [Using GitHub1s](docs/usage.md)      | Navigation, authentication, search, and troubleshooting |
+| [GitHub1s AI](docs/ai.md)            | Model setup, context, tools, and data handling          |
+| [Development](docs/development.md)   | Local setup, builds, and checks                         |
+| [Architecture](docs/architecture.md) | Components, data flow, and source layout                |
+| [Deployment](docs/deployment.md)     | Hosting, OAuth, and service configuration               |
+| [Community](docs/community.md)       | Third-party extensions and star history                 |
 
-### Firefox Extensions
+## 🤝 Contributing
 
-- [Repositree](https://addons.mozilla.org/en-US/firefox/addon/repositree/) ([chouglesaud/repositree](https://github.com/chouglesaud/repositree))
-- [Github1s Extension](https://addons.mozilla.org/firefox/addon/github1s-extension) ([Darkempire78/GitHub1s-Extension](https://github.com/Darkempire78/GitHub1s-Extension))
-- [Github1s](https://addons.mozilla.org/firefox/addon/github1s/) ([mcherifi/github1s-firefox-addon](https://github.com/mcherifi/github1s-firefox-addon))
-- [Github Web IDE](https://addons.mozilla.org/firefox/addon/github-web-ide/) ([zvizvi/Github-Web-IDE](https://github.com/zvizvi/Github-Web-IDE))
+See the [development guide](docs/development.md) to run GitHub1s locally. Report bugs and suggest improvements through [GitHub Issues](https://github.com/conwnet/github1s/issues).
 
-### Microsoft Edge Extensions
+## 👥 Maintainers
 
-- [github-code-viewer](https://microsoftedge.microsoft.com/addons/detail/githubcodeviewer/jaaaapanahkknbgdbglnlchbjfhhjlpi) ([febaoshan/edge-extensions-github-code-viewer](https://github.com/febaoshan/edge-extensions-github-code-viewer))
-- [Github Web IDE](https://microsoftedge.microsoft.com/addons/detail/akjbkjciknacicbnkfjbnlaeednpadcf) ([zvizvi/Github-Web-IDE](https://github.com/zvizvi/Github-Web-IDE))
+[conwnet](https://github.com/conwnet) · [xcv58](https://github.com/xcv58) · [Siddhant Khare](https://github.com/Siddhant-K-code)
 
-### Safari Extension
+## 💖 Thanks
 
-- [GitHub1s-For-Safari-Extension](https://apps.apple.com/us/app/readcodeonline/id1569026520?mt=12) ([code4you2021/GitHub1s-For-Safari-Extension](https://github.com/code4you2021/GitHub1s-For-Safari-Extension))
+Thanks to everyone who has contributed to GitHub1s, and to [Sourcegraph](https://sourcegraph.com/), [searchcode](https://searchcode.com/), and [OSS Insight](https://ossinsight.io/) for the tools and services used by GitHub1s.
 
-### Tampermonkey scripts
+## 📄 License
 
-- [Mr-B0b/TamperMonkeyScripts/vscode.js](https://github.com/Mr-B0b/TamperMonkeyScripts/blob/main/vscode.js)
-</details>
+[MIT](LICENSE)