{"id":17930983,"url":"https://github.com/gowthertg/tux","last_synced_at":"2026-04-02T03:02:43.434Z","repository":{"id":259177259,"uuid":"876502236","full_name":"GowthertG/Tux","owner":"GowthertG","description":"Tux is a flexible tmux-based automation script that sets up project environments for various development workflows such as Django, NestJS, or Docker Compose. It creates separate tmux windows for code editing (Neovim), shell commands, and live server execution.","archived":false,"fork":false,"pushed_at":"2024-11-02T23:42:47.000Z","size":13,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-08T23:45:47.900Z","etag":null,"topics":["bash-script","django","docker","docker-compose","neovim","nestjs","tmux"],"latest_commit_sha":null,"homepage":"","language":"Shell","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/GowthertG.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":"2024-10-22T04:42:45.000Z","updated_at":"2024-11-02T23:42:51.000Z","dependencies_parsed_at":"2024-10-24T02:36:22.187Z","dependency_job_id":null,"html_url":"https://github.com/GowthertG/Tux","commit_stats":null,"previous_names":["gowthertg/django-tmux","gowthertg/tux"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GowthertG%2FTux","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GowthertG%2FTux/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GowthertG%2FTux/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GowthertG%2FTux/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/GowthertG","download_url":"https://codeload.github.com/GowthertG/Tux/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246982710,"owners_count":20864146,"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","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":["bash-script","django","docker","docker-compose","neovim","nestjs","tmux"],"created_at":"2024-10-28T21:18:54.348Z","updated_at":"2025-12-30T20:27:20.161Z","avatar_url":"https://github.com/GowthertG.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n# Tux\n\n`tux` is a flexible tmux-based automation script that sets up project environments for various development workflows such as Django, NestJS, or Docker Compose. It creates separate `tmux` windows for code editing (Neovim), shell commands, and live server execution.\n\n## Features\n\n- **Vim Window**: Launches Neovim for code editing.\n- **BASH Window**: Prepares a terminal window for running commands.\n- **Live Server Window**: Automatically starts either the Django server, NestJS app, or Docker Compose.\n\n## Installation\n\n1. Clone the repository and copy the script to your local `bin` folder:\n\n   ```bash\n   git clone https://github.com/GowthertG/Tux.git\n   cp Tux/tux ~/.local/bin/tux\n   chmod +x ~/.local/bin/tux\n   ```\n\n2. Make sure `~/.local/bin` is added to your PATH if it's not already included.\n\n## Usage\n\n#### Navigate to your working directory:\n- First, `cd` to the root of your project directory where the script will be executed. Ensure that you have the correct setup (e.g., .venv for virtual environments).\n\n``` bash\n\ncd /path/to/your/project\n```\n\nRun the Tux script with one of the following options:\n\n- `-d`: Starts a tmux session with a Django development server.\n- `-j`: Starts a tmux session with a NestJS application.\n- `-c`: Starts a tmux session with Docker Compose.\n\n### Example Commands\n\n1. **To start a Django project**:\n\n   ```bash\n   tux -d\n   ```\n\n2. **To start a NestJS project**:\n\n   ```bash\n   tux -j\n   ```\n\n3. **To start a Docker Compose setup**:\n\n   ```bash\n   tux -c\n   ```\n\n4. **To reattach to an existing session**:\n\n   Simply run the same command, or just `tux` and `tmux` will reattach to the session.\n\n## Customization\n\n   Since this is a simple script, you can modify it locally to suit your specific needs.\n\n## Requirements\n\n- Ensure you have a `.venv` directory in your project root for the Python virtual environment (or adjust the script if you use a different name).\n- `tmux` installed.\n- `Neovim` installed.\n  \n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgowthertg%2Ftux","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgowthertg%2Ftux","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgowthertg%2Ftux/lists"}