{"id":13492353,"url":"https://github.com/ivaaaan/smug","last_synced_at":"2025-10-21T04:53:48.463Z","repository":{"id":38108829,"uuid":"323073412","full_name":"ivaaaan/smug","owner":"ivaaaan","description":"Session manager and task runner for tmux. Start your development environment within one command.","archived":false,"fork":false,"pushed_at":"2025-09-26T08:56:34.000Z","size":152,"stargazers_count":779,"open_issues_count":13,"forks_count":30,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-09-27T03:47:03.659Z","etag":null,"topics":["go","golang","hacktoberfest","tmux"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ivaaaan.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null},"funding":{"patreon":"iillexial","open_collective":"smug"}},"created_at":"2020-12-20T13:04:19.000Z","updated_at":"2025-09-26T12:41:15.000Z","dependencies_parsed_at":"2024-01-25T05:09:51.163Z","dependency_job_id":"e0170e51-4768-4cd1-8b84-7fcf868c788d","html_url":"https://github.com/ivaaaan/smug","commit_stats":{"total_commits":122,"total_committers":12,"mean_commits":"10.166666666666666","dds":"0.28688524590163933","last_synced_commit":"3098fbf7e2065dbd074f4c527eb37db8da0e44c6"},"previous_names":[],"tags_count":33,"template":false,"template_full_name":null,"purl":"pkg:github/ivaaaan/smug","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ivaaaan%2Fsmug","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ivaaaan%2Fsmug/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ivaaaan%2Fsmug/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ivaaaan%2Fsmug/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ivaaaan","download_url":"https://codeload.github.com/ivaaaan/smug/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ivaaaan%2Fsmug/sbom","scorecard":{"id":497895,"data":{"date":"2025-08-11","repo":{"name":"github.com/ivaaaan/smug","commit":"3d7983a7b08d249bcf4e7a0f9752d51c5a892f51"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":4.1,"checks":[{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Maintained","score":0,"reason":"1 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Code-Review","score":2,"reason":"Found 6/29 approved changesets -- score normalized to 2","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Pinned-Dependencies","score":2,"reason":"dependency not pinned by hash detected -- score normalized to 2","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/go.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/ivaaaan/smug/go.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/go.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/ivaaaan/smug/go.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/homebrew.yml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/ivaaaan/smug/homebrew.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/ivaaaan/smug/release.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/ivaaaan/smug/release.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:24: update your workflow using https://app.stepsecurity.io/secureworkflow/ivaaaan/smug/release.yml/master?enable=pin","Warn: downloadThenRun not pinned by hash: .github/workflows/go.yml:28","Info:   0 out of   4 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   2 third-party GitHubAction dependencies pinned","Info:   1 out of   1 goCommand dependencies pinned","Info:   0 out of   1 downloadThenRun dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/go.yml:1","Warn: no topLevel permission defined: .github/workflows/homebrew.yml:1","Warn: topLevel 'contents' permission set to 'write': .github/workflows/release.yml:9","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Packaging","score":10,"reason":"packaging workflow detected","details":["Info: Project packages its releases by way of GitHub Actions.: .github/workflows/release.yml:12"],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Branch-Protection","score":-1,"reason":"internal error: error during branchesHandler.setup: internal error: githubv4.Query: Resource not accessible by integration","details":null,"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Signed-Releases","score":0,"reason":"Project has not signed or included provenance with any releases.","details":["Warn: release artifact v0.3.7 not signed: https://api.github.com/repos/ivaaaan/smug/releases/222792652","Warn: release artifact v0.3.6 not signed: https://api.github.com/repos/ivaaaan/smug/releases/188730621","Warn: release artifact v0.3.5 not signed: https://api.github.com/repos/ivaaaan/smug/releases/179506218","Warn: release artifact v0.3.3 not signed: https://api.github.com/repos/ivaaaan/smug/releases/77663639","Warn: release artifact v0.3.2 not signed: https://api.github.com/repos/ivaaaan/smug/releases/72403990","Warn: release artifact v0.3.7 does not have provenance: https://api.github.com/repos/ivaaaan/smug/releases/222792652","Warn: release artifact v0.3.6 does not have provenance: https://api.github.com/repos/ivaaaan/smug/releases/188730621","Warn: release artifact v0.3.5 does not have provenance: https://api.github.com/repos/ivaaaan/smug/releases/179506218","Warn: release artifact v0.3.3 does not have provenance: https://api.github.com/repos/ivaaaan/smug/releases/77663639","Warn: release artifact v0.3.2 does not have provenance: https://api.github.com/repos/ivaaaan/smug/releases/72403990"],"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 26 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-19T20:58:14.501Z","repository_id":38108829,"created_at":"2025-08-19T20:58:14.501Z","updated_at":"2025-08-19T20:58:14.501Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":280207194,"owners_count":26290616,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-21T02:00:06.614Z","response_time":58,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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","golang","hacktoberfest","tmux"],"created_at":"2024-07-31T19:01:05.231Z","updated_at":"2025-10-21T04:53:48.458Z","avatar_url":"https://github.com/ivaaaan.png","language":"Go","funding_links":["https://patreon.com/iillexial","https://opencollective.com/smug"],"categories":["Go","\u003ca name=\"tools\"\u003e\u003c/a\u003eTools and session management"],"sub_categories":[],"readme":"# Smug - tmux session manager\n\n[![Actions Status](https://github.com/ivaaaan/smug/workflows/Go/badge.svg)](https://github.com/ivaaaan/smug/actions)\n[![Go Report Card](https://goreportcard.com/badge/github.com/ivaaaan/smug)](https://goreportcard.com/report/github.com/ivaaaan/smug)\n\nInspired by [tmuxinator](https://github.com/tmuxinator/tmuxinator) and [tmuxp](https://github.com/tmux-python/tmuxp).\n\nSmug automates your [tmux](https://github.com/tmux/tmux) workflow. You can create a single configuration file, and Smug will create all the required windows and panes from it.\n\n![gif](https://raw.githubusercontent.com/ivaaaan/gifs/master/smug.gif)\n\nThe configuration used in this GIF can be found [here](#example-2).\n\n## Installation\n\n### Download from the releases page\n\nDownload the latest version of Smug from the [releases page](https://github.com/ivaaaan/smug/releases) and then run:\n\n```bash\nmkdir smug \u0026\u0026 tar -xzf smug_0.1.0_Darwin_x86_64.tar.gz -C ./smug \u0026\u0026 sudo mv smug/smug /usr/local/bin \u0026\u0026 rm -rf smug\n```\n\nDon't forget to replace `smug_0.1.0_Darwin_x86_64.tar.gz` with the archive that you've downloaded.\n\n### Go (recommended)\n\n#### Prerequisite Tools\n\n- [Git](https://git-scm.com/)\n- [Go (we test it with the last 2 major versions)](https://golang.org/dl/)\n\n#### Fetch from GitHub\n\nThe easiest way is to clone Smug from GitHub and install it using `go-cli`:\n\n```bash\ngo install github.com/ivaaaan/smug@latest\n```\n\n### macOS\n\nOn macOS, you can install Smug using [MacPorts](https://www.macports.org) or [Homebrew](https://brew.sh).\n\n#### Homebrew\n\n```bash\nbrew install smug\n```\n\n#### MacPorts\n\n```bash\nsudo port selfupdate\nsudo port install smug\n```\n\n### Linux\n\n#### Arch\n\nThere's [AUR](https://aur.archlinux.org/packages/smug) with smug.\n\n```bash\ngit clone https://aur.archlinux.org/smug.git\ncd smug\nmakepkg -si\n```\n\n## Usage\n\n```\nsmug \u003ccommand\u003e [\u003cproject\u003e] [-f, --file \u003cfile\u003e] [-w, --windows \u003cwindow\u003e]... [-a, --attach] [-d, --debug]\n```\n\n### Options:\n\n```\n-f, --file A custom path to a config file\n-w, --windows List of windows to start. If session exists, those windows will be attached to current session.\n-a, --attach Force switch client for a session\n-i, --inside-current-session Create all windows inside current session\n-d, --debug Print all commands to ~/.config/smug/smug.log\n--detach Detach session. The same as `-d` flag in the tmux\n```\n\n### Custom settings\n\nYou can pass custom settings into your configuration file. Use `${variable_name}` syntax in your config and then pass key-value args:\n\n```console\nxyz@localhost:~$ smug start project variable_name=value\n```\n\n### Examples\n\nTo create a new project, or edit an existing one in the `$EDITOR`:\n\n```console\nxyz@localhost:~$ smug new project\n\nxyz@localhost:~$ smug edit project\n```\n\nTo start/stop a project and all windows, run:\n\n```console\nxyz@localhost:~$ smug start project\n\nxyz@localhost:~$ smug stop project\n```\n\nAlso, smug has aliases to the most of the commands:\n\n```console\nxyz@localhost:~$ smug project # the same as \"smug start project\"\n\nxyz@localhost:~$ smug st project # the same as \"smug stop project\"\n\nxyz@localhost:~$ smug p ses # the same as \"smug print ses\"\n```\n\nWhen you already have a running session, and you want only to create some windows from the configuration file, you can do something like this:\n\n```console\nxyz@localhost:~$ smug start project:window1\n\nxyz@localhost:~$ smug start project:window1,window2\n\nxyz@localhost:~$ smug start project -w window1\n\nxyz@localhost:~$ smug start project -w window1 -w window2\n\nxyz@localhost:~$ smug stop project:window1\n\nxyz@localhost:~$ smug stop project -w window1 -w window2\n```\n\nAlso, you are not obliged to put your files in the `~/.config/smug` directory. You can use a custom path in the `-f` flag:\n\n```console\nxyz@localhost:~$ smug start -f ./project.yml\n\nxyz@localhost:~$ smug stop -f ./project.yml\n\nxyz@localhost:~$ smug start -f ./project.yml -w window1 -w window2\n```\n\n## Configuration\n\nConfiguration files can stored in the `~/.config/smug` directory in the `YAML` format, e.g `~/.config/smug/your_project.yml`.\nYou may also create a file named `.smug.yml` in the current working directory, which will be used by default.\n\n### Examples\n\n#### Example 1\n\n```yaml\nsession: blog\n\nroot: ~/Developer/blog\n\nbefore_start:\n  - docker-compose -f my-microservices/docker-compose.yml up -d # my-microservices/docker-compose.yml is a relative to `root`\n\nenv:\n  FOO: BAR\n\nstop:\n  - docker stop $(docker ps -q)\n\nwindows:\n  - name: code\n    root: blog # a relative path to root\n    manual: true # you can start this window only manually, using the -w arg\n    layout: main-vertical\n    commands:\n      - docker-compose start\n    panes:\n      - type: horizontal\n        root: .\n        commands:\n          - docker-compose exec php /bin/sh\n          - clear\n\n  - name: infrastructure\n    root: ~/Developer/blog/my-microservices\n    layout: tiled\n    panes:\n      - type: horizontal\n        root: .\n        commands:\n          - docker-compose up -d\n          - docker-compose exec php /bin/sh\n          - clear\n```\n\n#### Example 2\n\n```yaml\nsession: blog\n\nroot: ~/Code/blog\n\nbefore_start:\n  - docker-compose up -d\n\nstop:\n  - docker-compose stop\n\nwindows:\n  - name: code\n    selected: true # Selects this window at the start of the session\n    layout: main-horizontal\n    commands:\n      - $EDITOR app/dependencies.php\n    panes:\n      - type: horizontal\n        commands:\n          - make run-tests\n  - name: ssh\n    commands:\n      - ssh -i ~/keys/blog.pem ubuntu@127.0.0.1\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fivaaaan%2Fsmug","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fivaaaan%2Fsmug","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fivaaaan%2Fsmug/lists"}