switchyard
Rules-based browser gateway and link redirector.
File Explorer
Download Latest Version (.zip)- ci.yml
- nix.yml
- website.yml
- FUNDING.yml
- .python-version
- main.py
- pyproject.toml
- browser.go
- main.go
- model.go
- styles.go
- main.go
- io.github.alyraffauf.Switchyard.svg
- launcher.png
- io.github.alyraffauf.Switchyard.desktop
- io.github.alyraffauf.Switchyard.metainfo.xml
- default.nix
- devShells.nix
- git-hooks-nix.nix
- hm-module.nix
- packages.nix
- treefmt.nix
- glib-appinfo.patch
- go-modules.json
- io.github.alyraffauf.Switchyard.Devel.yml
- switchyard-wrapper.sh
- app.go
- browser.go
- config.go
- dialog_about.go
- dialog_default_browser.go
- dialog_helpers.go
- dialog_hidden_browsers.go
- dialog_redirection.go
- dialog_rule_add.go
- dialog_rule_common.go
- dialog_rule_edit.go
- launcher_actions.go
- native_host.go
- run.go
- settings_advanced.go
- settings_appearance.go
- settings_behavior.go
- settings_redirections.go
- settings_rules.go
- ui_helpers.go
- window_launcher.go
- window_settings.go
- actions.go
- browser.go
- launch.go
- launch_common.go
- launch_darwin.go
- launch_darwin_test.go
- launch_test.go
- actions.go
- browserscan.go
- browserscan_darwin.go
- browserscan_darwin_test.go
- browserscan_test.go
- common.go
- locale.go
- locale_test.go
- nsworkspace_darwin.m
- config.go
- config_test.go
- match_test.go
- host.go
- host_test.go
- adguard_filter.txt
- format.go
- model.go
- model_test.go
- pattern.go
- pattern_test.go
- pipeline.go
- redirection.go
- redirection_test.go
- sanitizer.go
- sanitizer_test.go
- url.go
- url_test.go
- validation.go
- validation_test.go
- sw.nix
- switchyard.nix
- generate-flatpak-go-modules.py
- install-desktop-integration.py
- install-desktop-integration.sh
- switchyard-128.png
- switchyard-16.png
- switchyard-48.png
- switchyard.svg
- App.tsx
- background.ts
- icons.tsx
- esbuild.config.mjs
- manifest.firefox.json
- manifest.json
- package-lock.json
- package.json
- popup.html
- tsconfig.json
- icon.svg
- generate-og-image.mjs
- browser-rules.png
- edit-rules.png
- launcher.png
- link-redirections.png
- swtui.png
- Logo.astro
- SiteFooter.astro
- SiteHeader.astro
- configuration.md
- home-manager.md
- nixos-flatpak.md
- prior-art.md
- tui.md
- uri-scheme.md
- using.md
- webextension.md
- DocsLayout.astro
- [slug].astro
- index.astro
- index.astro
- index.css
- content.config.ts
- site.ts
- .dockerignore
- .gitignore
- .prettierrc
- astro.config.mjs
- Dockerfile
- eslint.config.js
- package-lock.json
- package.json
- README.md
- tsconfig.json
- .envrc
- .gitignore
- .prettierignore
- flake.lock
- flake.nix
- go.mod
- go.sum
- justfile
- LICENSE.md
- README.md
# Installation Guide
1. Get the code
git clone https://github.com/alyraffauf/switchyard
Downloads the entire project code from GitHub to your computer.
cd switchyard
Moves into the project folder you just downloaded.
2. Node.js
Easy RecommendedPrerequisites
cd webextension
This project's files live in a subfolder, so move into it first.
npm install
Downloads and installs the libraries listed in package.json.
npm start
Starts the development/run server.
After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.
3. Python
EasyPrerequisites
pip install .
Installs the package published on PyPI directly β no need to clone the source.
python <μ€νν νμΌλͺ
>.py # READMEμμ μ νν μ€ν νμΌλͺ
μ νμΈνμΈμ
Runs the Python script (or module).
If it runs without errors and prints output in the terminal, it worked.
4. Go
MediumPrerequisites
go build ./...
Compiles the Go program into an executable.
go run .
Runs the Go program directly without a separate build step.
If the build finishes without errors, it worked. If you used go run ., check the terminal output.
// repository documentation
Was this content helpful?
(0 ratings)