Spaces:
Sleeping
Sleeping
|
Download README.md from brianbellx/codehygiene: direct link, hf CLI and curl.
- Browser
- Download file 1.57 kB
-
https://huggingface.co/spaces/brianbellx/codehygiene/resolve/main/README.md
- Command line
-
hf download hf://spaces/brianbellx/codehygiene/README.md
-
curl -L -o README.md https://huggingface.co/spaces/brianbellx/codehygiene/resolve/main/README.md
1.57 kB
| title: codehygiene | |
| emoji: 🧹 | |
| colorFrom: gray | |
| colorTo: green | |
| sdk: docker | |
| app_port: 7860 | |
| short_description: Find hard-to-read code in any GitHub repo | |
| tags: | |
| - code-quality | |
| - readability | |
| # codehygiene | |
| Paste a GitHub link, upload a local folder, or paste a snippet to inspect structural readability issues in milliseconds. | |
| The `23.84 KiB` ternary neural scorer (`codehygiene` `v0.6.1`) runs locally inside Web Workers in your browser — source code is never uploaded to score it. Public repositories can also be ranked on the [Leaderboard](TELEMETRY.md#leaderboard). | |
| ## Settings | |
| | Variable | Default | What it does | | |
| |---|---|---| | |
| | `CODEHYGIENE_REF` | pinned commit | Build arg. Version of `codehygiene` (`engine.js`, `weights.npz`, and Python package). | | |
| | `HF_STATS_DATASET_REPO` | unset | Optional Hugging Face Dataset repo storing aggregate `stats.json` and `leaderboard.json`. | | |
| | `HF_TOKEN` | unset | Optional dataset-scoped write token for persisting `stats.json` and `leaderboard.json`. | | |
| | `STATS_SYNC_SECONDS` | `300` | Seconds between dataset flushes. | | |
| | `GITHUB_TOKEN` | unset | Optional zero-permission token raising GitHub API read limits for leaderboard ranking. | | |
| | `LEADERBOARD_SEED` | `1` | Rank canonical seed repos in the background on startup. | | |
| | `LEADERBOARD_SEED_PAUSE` | `20` | Seconds between background seed rankings. | | |
| Aggregate counters and privacy rules are documented in [TELEMETRY.md](TELEMETRY.md). | |
| ## Run locally | |
| ```bash | |
| npm --prefix web run build | |
| LEADERBOARD_SEED=0 python -m uvicorn server.app:app --port 7860 | |
| ``` | |