{"_id":"@atomashevic/cliweb","name":"@atomashevic/cliweb","dist-tags":{"latest":"2.0.5"},"versions":{"2.0.5":{"name":"@atomashevic/cliweb","version":"2.0.5","description":"A full graphical web browser for Kitty-compatible terminals","author":{"name":"Chase Colman"},"license":"BSD-3-Clause","homepage":"https://github.com/atomashevic/cliweb","repository":{"type":"git","url":"git+https://github.com/atomashevic/cliweb.git"},"bugs":{"url":"https://github.com/atomashevic/cliweb/issues"},"keywords":["browser","electron","ghostty","kitty","terminal"],"bin":{"cliweb":"dist/runner/index.js"},"publishConfig":{"access":"public"},"os":["darwin","linux"],"cpu":["arm64","x64"],"engines":{"node":">=22.11.0"},"packageManager":"bun@1.3.14","workspaces":["src/runner","cliweb-native-rs"],"scripts":{"build":"bun run scripts/build-package.ts","build:native":"bun run --cwd cliweb-native-rs make","prepack":"node scripts/run-build.js","postinstall":"node scripts/configure-sandbox.js","start":"node dist/runner/index.js","pack:dry-run":"npm pack --dry-run","format":"biome format --write .","lint":"biome lint ./src ./scripts","lint-fix":"biome lint --write ./src ./scripts","lint-fix-unsafe":"biome lint --write --unsafe ./src ./scripts","input-test":"bun run ./src/tty/inputTest.ts","gfx-test":"bun run ./src/tty/graphicsTest.ts","bump-crossterm":"git subtree pull --prefix=cliweb-native-rs/crates/crossterm --squash https://github.com/crossterm-rs/crossterm master","typecheck":"tsc --noEmit --skipLibCheck && tsc --project src/runner/tsconfig.json"},"dependencies":{"cliweb-native-rs":"2.0.5","electron":"^37.3.1","electron-chrome-extensions":"^4.9.0","electron-chrome-web-store":"^0.13.0"},"devDependencies":{"@biomejs/biome":"2.2.2","@sinonjs/fake-timers":"^14.0.0","@types/node":"^24.3.0","@types/sinonjs__fake-timers":"^8.1.5","bun":"1.3.14","esbuild":"^0.25.0","typescript":"^5.9.2"},"trustedDependencies":["@biomejs/biome","@tailwindcss/oxide","bun","cliweb-native-rs","core-js","electron","esbuild"],"patchedDependencies":{"lru-cache@5.1.1":"patches/lru-cache@5.1.1.patch"},"_id":"@atomashevic/cliweb@2.0.5","_integrity":"sha512-SRqiez55RR6bEIEH2mIbUtVdEdMXdLM7/Mc8jlosI4mXhbuPivt+1+Y58OP/L6ctnePZgDNaBKmKwvE59B4f7w==","_resolved":"/home/aleksandar/work/cliweb-release-2.0.5/tarballs/atomashevic-cliweb-2.0.5.tgz","_from":"file:atomashevic-cliweb-2.0.5.tgz","_nodeVersion":"22.22.1","_npmVersion":"9.2.0","dist":{"integrity":"sha512-SRqiez55RR6bEIEH2mIbUtVdEdMXdLM7/Mc8jlosI4mXhbuPivt+1+Y58OP/L6ctnePZgDNaBKmKwvE59B4f7w==","shasum":"33ff674695d0efcd9cf78e8845974250bcea9f5d","tarball":"https://registry.npmjs.org/@atomashevic/cliweb/-/cliweb-2.0.5.tgz","fileCount":13,"unpackedSize":91293,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEQCICyCR7+o27ATm3MB/qn/fzYrYrqdVWpCYJ/etv5qkTUMAiBqXm5y2K23t8Zlsf39GXl57r8FQ2VLQ9X0GaOCzKYM2A=="}]},"_npmUser":{"name":"atomashevic","email":"atomashevic@gmail.com"},"directories":{},"maintainers":[{"name":"atomashevic","email":"atomashevic@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/cliweb_2.0.5_1784203929712_0.38253695639135366"},"_hasShrinkwrap":false}},"time":{"created":"2026-07-16T12:12:09.578Z","2.0.5":"2026-07-16T12:12:09.872Z","modified":"2026-07-16T12:12:10.050Z"},"maintainers":[{"name":"atomashevic","email":"atomashevic@gmail.com"}],"description":"A full graphical web browser for Kitty-compatible terminals","homepage":"https://github.com/atomashevic/cliweb","keywords":["browser","electron","ghostty","kitty","terminal"],"repository":{"type":"git","url":"git+https://github.com/atomashevic/cliweb.git"},"author":{"name":"Chase Colman"},"bugs":{"url":"https://github.com/atomashevic/cliweb/issues"},"license":"BSD-3-Clause","readme":"# CLI Web Browser\n\nOr just `cliweb`.\n\nActual Chromium being rendered in your favorite terminal that supports the [Kitty terminal graphics protocol](https://sw.kovidgoyal.net/kitty/graphics-protocol/).\n\n**`cliweb` works best in [Kitty v0.31 or newer](https://github.com/kovidgoyal/kitty/releases)**\n\n## Why?\n\n- Display documentation from [DevDocs](https://devdocs.io)\n- Watch the changes from [Vite](https://vitejs.dev) come to life\n- Tiled layout without a tiling window manager using [Kitty's layouts](https://sw.kovidgoyal.net/kitty/layouts/)\n- Add fancy UI using web technologies, so NeoVim can pretend it is Emacs instead of the other way around\n\n## Installation\n\nInstall the published command globally with npm:\n\n```bash\nnpm install --global @atomashevic/cliweb\n```\n\nThe npm package contains prebuilt application and toolbar assets. It does not\nbuild the TypeScript application on first launch.\n\nSee [npm packaging](docs/NPM_PACKAGING.md) for the package layout and release\nworkflow.\n\n## Usage\n\n```bash\ncliweb [url]\n\n# if url is not provided, it will go to the cliweb homepage (this is temporary, promise)\n# the URL protocol can be http:, https:, or data:\n# if the URL protocol is not included, https: is used by default\n```\n\nFor more options look at the help:\n\n```bash\ncliweb --help\n```\n\n### tmux\n\n`cliweb` can render in a local tmux pane when passthrough is enabled:\n\n```tmux\nset -g allow-passthrough on\n```\n\ntmux 3.3 or newer is required for configurable passthrough, and tmux 3.6 or newer is recommended\nfor reliable pane pixel dimensions. The tmux server and terminal emulator must run on the same\nmachine because `cliweb` transfers frames through POSIX shared memory; tmux over SSH is not yet\nsupported.\n\n## Configuration\n\n`cliweb` can be configured through `$XDG_CONFIG_HOME/cliweb/config.js`, or\n`~/.config/cliweb/config.js` when `XDG_CONFIG_HOME` is not set. The default\nconfiguration is copied there on first launch. Changes update any running\n`cliweb` process.\n\nCurrently it only supports custom keybindings and changing the homepage that displays when no URL is provided.\n\nFor more details on keybinding syntax and available actions, see the comments in `config.js`.\n\n## Contributing\n\nSee [Contributing to Cliweb](/CONTRIBUTING.md#contributing-to-cliweb).\n\n## Development\n\nClone the repository and run the local setup script:\n\n```bash\ngit clone https://github.com/atomashevic/cliweb.git\ncd cliweb\n./setup.sh\n```\n\nYou can update your checkout to use another fork by changing the origin:\n\n```bash\n# note: you'll have to change the username some-kind-contributor to your GitHub username\ngit remote set-url origin git@github.com:some-kind-contributor/cliweb.git\n# also track the upstream electron branch\ngit remote add upstream -f -t electron git@github.com:atomashevic/cliweb.git\n```\n\nYou can make a branch (ex: my-feature-branch) off the latest changes by doing:\n\n```\ngit fetch upstream electron\ngit checkout upstream/electron\ngit switch -c 'my-feature-branch'\n```\n\nRead [Your First Code Contribution](/CONTRIBUTING.md#your-first-code-contribution) for more information on making a PR.\n","readmeFilename":"README.md","_rev":"1-a330987fe9a742fd4ea933746ea9b156"}