{"id":36478985,"url":"https://github.com/samredai/sludge","last_synced_at":"2026-01-12T01:00:07.245Z","repository":{"id":115967171,"uuid":"523456252","full_name":"samredai/sludge","owner":"samredai","description":"A Terminal UI For SLURM","archived":false,"fork":false,"pushed_at":"2022-11-06T23:44:59.000Z","size":1009,"stargazers_count":4,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-06-21T17:01:18.313Z","etag":null,"topics":["go","hpc-clusters","sludge","slurm","terminal-ui"],"latest_commit_sha":null,"homepage":"https://www.sludgeui.com/","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/samredai.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-08-10T18:34:12.000Z","updated_at":"2022-12-26T09:00:37.000Z","dependencies_parsed_at":"2023-04-23T11:04:52.022Z","dependency_job_id":null,"html_url":"https://github.com/samredai/sludge","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/samredai/sludge","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/samredai%2Fsludge","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/samredai%2Fsludge/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/samredai%2Fsludge/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/samredai%2Fsludge/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/samredai","download_url":"https://codeload.github.com/samredai/sludge/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/samredai%2Fsludge/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28330143,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-12T00:36:25.062Z","status":"ssl_error","status_checked_at":"2026-01-12T00:36:15.229Z","response_time":60,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["go","hpc-clusters","sludge","slurm","terminal-ui"],"created_at":"2026-01-12T01:00:06.572Z","updated_at":"2026-01-12T01:00:07.227Z","avatar_url":"https://github.com/samredai.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"![sludge-logo](docs/static/images/sludge-logo2.png)\n\nSludge is a terminal UI for [SLURM](https://slurm.schedmd.com/documentation.html), a cluster management and job scheduling system.\nTo learn more about it, head over to the [documentation](https://www.sludgeui.com) site.\n\n# Installation\n\n## Linux\n\nCreate a `bin` directory and download the sludge binary there.\n```sh\nmkdir -p $HOME/bin\ncd $HOME/bin\nwget -P $HOME/bin https://github.com/samredai/sludge/releases/download/0.1.0-alpha.1/sludge-linux-amd64 -O sludge\nchmod +x $HOME/bin/sludge\n```\n\nAdd the bin directory to your `PATH` variable by including the following in your `~/.bashrc` file.\n```sh\nexport PATH=$HOME/bin:$PATH\n```\n\n# Usage\n\nThe sludge terminal UI can be opened using the `sludge` command.\n```sh\nsludge\n```\n[![welcome-page](docs/static/images/welcome-page.png)](docs/static/images/welcome-page.png)\n\nThe sludge UI can be closed using either `Ctrl+C` or `Ctrl+D`.\n\n## Filtering to a Specific User\n\nThe `--username` argument opens sludge with all views filtered to a specific user.\n```sh\nsludge --username samredai\n```\n\n## Filtering to a Specific Account\n\nThe `--account` argument opens sludge with all views filtered to a specific account.\n```sh\nsludge --account heavy_metal_lab\n```\n\n## Jobs Page\n\nYou can view all jobs on the SLURM cluster by going to the jobs page `[Ctrl+J]`. Selecting a job will reveal more information about the job in the center pane, such as number of nodes, number of CPUs, and the number of threads per core.\n\n[![job-details](docs/static/images/job-details.png)](docs/static/images/job-details.png)\n\n## Nodes Page\n\nYou can view all nodes on the SLURM cluster by going to the nodes page `[Ctrl+N]`. Selecting a node will reveal more information about the node in the center pane, such as the architechture, the number of cores and the CPU load.\n\n## Reports Page\n\nSludge lets you run various reports on the SLURM cluster and displays the results. On the reports page `[Ctrl+R]`, you can select which report you want to run in the left pane. Once the results are ready, they will be displayed in the center pane. The reports are submitted using the `sreport` command line utility that comes with SLURM.\n\n[![reports-page](docs/static/images/reports-page.png)](docs/static/images/reports-page.png)\n\n# Actions\n\nThe actions menus can be found in the top right pane and contains various forms that can be used to run common actions against the SLURM cluster such as submitting a script using `sbatch` or running an analysis to determine the best partition for a particular script.\n\n## Submit Script Action\n\nYou can submit a script to run on the SLURM cluster using the `Submit Script` action. In addition to the script name, you can include additional sbatch options as arguments.\nSee the [sbatch](https://slurm.schedmd.com/sbatch.html) documentation to see all available options.\n\n[![submit-script-action](docs/static/images/submit-script-action.png)](docs/static/images/submit-script-action.png)\n\n## Find Best Partition Action\n\nYou can find the SLURM partition with the minimum delay for starting a particular script using the Find Best Partition action. This uses the open source [BestSlurmPartition](https://github.com/fasrc/best_slurm_partition) utility created by the research computing team at the Harvard Faculty of Arts \u0026 Sciences (FASRC).\n\nTo use the action, simply select it in the actions pane and enter the path to the script you’d like to find the best partition for. Relative paths are calculated from the directory where the sludge UI was launched.\n\n[![find-best-partition-action](docs/static/images/find-best-partition-action.png)](docs/static/images/find-best-partition-action.png)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsamredai%2Fsludge","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsamredai%2Fsludge","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsamredai%2Fsludge/lists"}