{"id":15021635,"url":"https://github.com/skroczek/symfony-venv","last_synced_at":"2025-10-29T15:30:41.471Z","repository":{"id":39614845,"uuid":"220791419","full_name":"skroczek/symfony-venv","owner":"skroczek","description":"Creates a virtual environment for easily calling console binary plus some shortcuts.","archived":false,"fork":false,"pushed_at":"2019-11-22T19:13:57.000Z","size":88,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-01-18T01:50:25.990Z","etag":null,"topics":["autocomplete","bash","console","developer-experience","fish-shell","laravel","symfony","zsh"],"latest_commit_sha":null,"homepage":null,"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/skroczek.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}},"created_at":"2019-11-10T13:05:54.000Z","updated_at":"2023-12-01T08:00:12.000Z","dependencies_parsed_at":"2022-08-24T03:41:05.445Z","dependency_job_id":null,"html_url":"https://github.com/skroczek/symfony-venv","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/skroczek%2Fsymfony-venv","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/skroczek%2Fsymfony-venv/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/skroczek%2Fsymfony-venv/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/skroczek%2Fsymfony-venv/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/skroczek","download_url":"https://codeload.github.com/skroczek/symfony-venv/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":238840727,"owners_count":19539602,"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":["autocomplete","bash","console","developer-experience","fish-shell","laravel","symfony","zsh"],"created_at":"2024-09-24T19:56:49.366Z","updated_at":"2025-10-29T15:30:36.157Z","avatar_url":"https://github.com/skroczek.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"Create a vritual env for [Symfony](https://symfony.com/) and [Laravel](https://laravel.com/) projects. Highly inspired by the python virtualenv activate scripts, currently tested for bash, fish-shell and z-shell.\n\n![symfony-venv](symfony-venv.png)\n\nInstallation\n============\n\nMake sure Composer is installed globally, as explained in the\n[installation chapter](https://getcomposer.org/doc/00-intro.md)\nof the Composer documentation.\n\nAdd it to your symfony application\n----------------------------------------\n\n### Step 1: Download the Library\n\nOpen a command console, enter your project directory and execute the\nfollowing command to download the latest stable version of this bundle:\n\n```console\n$ composer require sk/symfony-venv\n```\n\n### Step 2: Activate virtual environment\n\nIn your project root dir run:\n\n#### Bash / Z-Shell\n\n```\n$ . vendor/bin/activate\n```\n\n#### Fish shell\n\n```\n$ . vendor/bin/activate.fish\n```\n### Step 3: Use it\n\nYou are now able to call the `console` and other scripts located under your projects /bin\ndirectory from everywhere. If you additionaly installed [symfony-console-autocomplete](https://github.com/bamarni/symfony-console-autocomplete)\nglobally the autocompletion for the console should work too.\n ```\n~/P/website-api $ . vendor/bin/activate\nwebsite-api (dev) ~/P/website-api $ console \u003cTAB\u003e\u003cTAB\u003e\nabout                                   debug:translation                       doctrine:mapping:import                 help                                    make:twig-extension\napi:json-schema:generate                debug:twig                              doctrine:mapping:info                   lint:twig                               make:unit-test\napi:openapi:export                      doctrine:cache:clear-collection-region  doctrine:migrations:diff                lint:xliff                              make:user\nassets:install                          doctrine:cache:clear-entity-region      doctrine:migrations:dump-schema         lint:yaml                               make:validator\ncache:clear                             doctrine:cache:clear-metadata           doctrine:migrations:execute             list                                    make:voter\ncache:pool:clear                        doctrine:cache:clear-query              doctrine:migrations:generate            make:auth                               router:match\ncache:pool:delete                       doctrine:cache:clear-query-region       doctrine:migrations:latest              make:command                            security:encode-password\ncache:pool:list                         doctrine:cache:clear-result             doctrine:migrations:migrate             make:controller                         server:dump\ncache:pool:prune                        doctrine:cache:contains                 doctrine:migrations:rollup              make:crud                               server:log\ncache:warmup                            doctrine:cache:delete                   doctrine:migrations:status              make:entity                             server:run\nconfig:dump-reference                   doctrine:cache:flush                    doctrine:migrations:up-to-date          make:fixtures                           server:start\ndebug:autowiring                        doctrine:cache:stats                    doctrine:migrations:version             make:form                               server:status\ndebug:config                            doctrine:database:create                doctrine:query:dql                      make:functional-test                    server:stop\ndebug:container                         doctrine:database:drop                  doctrine:query:sql                      make:migration                          swiftmailer:email:send\ndebug:event-dispatcher                  doctrine:database:import                doctrine:schema:create                  make:registration-form                  swiftmailer:spool:send\ndebug:form                              doctrine:ensure-production-settings     doctrine:schema:drop                    make:serializer:encoder                 translation:update\ndebug:router                            doctrine:generate:entities              doctrine:schema:update                  make:serializer:normalizer              \ndebug:swiftmailer                       doctrine:mapping:convert                doctrine:schema:validate                make:subscriber    \n ```\n\nor Laravel\n```\n~/P/blog $ . vendor/bin/activate\nblog (local) ~/P/blog$ artisan \u003cTAB\u003e\u003cTAB\u003e\napp:name             config:clear         event:generate       make:channel         make:listener        make:policy          migrate              notifications:table  queue:flush          route:cache          storage:link\nauth:clear-resets    db:seed              event:list           make:command         make:mail            make:provider        migrate:fresh        optimize             queue:forget         route:clear          tinker\ncache:clear          down                 help                 make:controller      make:middleware      make:request         migrate:install      optimize:clear       queue:listen         route:list           up\ncache:forget         dump-server          inspire              make:event           make:migration       make:resource        migrate:refresh      package:discover     queue:restart        schedule:finish      vendor:publish\ncache:table          env                  key:generate         make:exception       make:model           make:rule            migrate:reset        preset               queue:retry          schedule:run         view:cache\nclear-compiled       event:cache          list                 make:factory         make:notification    make:seeder          migrate:rollback     queue:failed         queue:table          serve                view:clear\nconfig:cache         event:clear          make:auth            make:job             make:observer        make:test            migrate:status       queue:failed-table   queue:work           session:table  \n```\n\n### Change environment\n\nThe command `e` set the APP_ENV environment variable. For older symfony installations, the SYMFONY_ENV is also set.\nOn activation the variable is initial set to `dev` on symfony, or `local` for laravel. The vars are not unset on\ndeactivation.\n\n```\nwebsite-api (dev) ~/P/website-api $ e prod\nwebsite-api (prod) ~/P/website-api $\n```\n### Clear cache\n\nThe venv adds also a shortcut for `console cache:clear`: `ccc`\n\n```\nwebsite-api (dev) ~/P/website-api $ ccc\n\n // Clearing the cache for the dev environment with debug true                                                          \n\n // Warming up cache...                                                                                                 \n\n // Removing old cache directory...                                                                                     \n\n // Finished         \n\n [OK] Cache for the \"dev\" environment (debug=true) was successfully cleared. \n\nwebsite-api (dev) ~/P/website-api $\n```\n\n### Last Step: Deactivate virtual environment\n\nTo deactivate the virtual environment all you have to do is to deactivate it:\n\n```\n$ deactivate\n```\n\nAutocompletion for console\n--------------------------\n\nIf [symfony-console-autocomplete](https://github.com/bamarni/symfony-console-autocomplete) is available in $PATH, the autocompletion\nis generated automatically for the console.\n\n*Caution*: If new commands are added to the console, they will not be recognized until the next activation.\n\n# Contributing\n\nWhen contributing to this repository, please first discuss the change you wish to make via issue,\nemail, or any other method with the owners of this repository before making a change. \n\nPlease note we have a code of conduct, please follow it in all your interactions with the project.\n\n## Pull Request Process\n\n1. Ensure any install or build dependencies are removed before the end of the layer when doing a \n   build.\n2. Update the README.md with details of changes to the interface, this includes new environment \n   variables, exposed ports, useful file locations and container parameters.\n3. Increase the version numbers in any examples files and the README.md to the new version that this\n   Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/).\n4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you \n   do not have permission to do that, you may request the second reviewer to merge it for you.\n\n## Code of Conduct\n\n### Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as\ncontributors and maintainers pledge to making participation in our project and\nour community a harassment-free experience for everyone, regardless of age, body\nsize, disability, ethnicity, gender identity and expression, level of experience,\nnationality, personal appearance, race, religion, or sexual identity and\norientation.\n\n### Our Standards\n\nExamples of behavior that contributes to creating a positive environment\ninclude:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or\nadvances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic\n  address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a\n  professional setting\n\n### Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable\nbehavior and are expected to take appropriate and fair corrective action in\nresponse to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or\nreject comments, commits, code, wiki edits, issues, and other contributions\nthat are not aligned to this Code of Conduct, or to ban temporarily or\npermanently any contributor for other behaviors that they deem inappropriate,\nthreatening, offensive, or harmful.\n\n### Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces\nwhen an individual is representing the project or its community. Examples of\nrepresenting a project or community include using an official project e-mail\naddress, posting via an official social media account, or acting as an appointed\nrepresentative at an online or offline event. Representation of a project may be\nfurther defined and clarified by project maintainers.\n\n### Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be\nreported by contacting the project team at me@xbug.de. All\ncomplaints will be reviewed and investigated and will result in a response that\nis deemed necessary and appropriate to the circumstances. The project team is\nobligated to maintain confidentiality with regard to the reporter of an incident.\nFurther details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good\nfaith may face temporary or permanent repercussions as determined by other\nmembers of the project's leadership.\n\n### Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,\navailable at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n\nLicence MIT\n===========\n\nCopyright 2019 Sebastian Kroczek \u003cme@xbug.de\u003e\n\nPermission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fskroczek%2Fsymfony-venv","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fskroczek%2Fsymfony-venv","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fskroczek%2Fsymfony-venv/lists"}