{"id":19776893,"url":"https://github.com/neoground/charm-toolkit","last_synced_at":"2026-05-09T20:41:59.857Z","repository":{"id":180346774,"uuid":"618981204","full_name":"neoground/charm-toolkit","owner":"neoground","description":"Charm-Toolkit: The ultimate CLI tool for streamlined Charm development, simplifying server setup, project management \u0026 so much more.","archived":false,"fork":false,"pushed_at":"2023-07-11T07:49:33.000Z","size":72,"stargazers_count":1,"open_issues_count":14,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-11T01:45:12.474Z","etag":null,"topics":["charm-framework","cli","command-line","php"],"latest_commit_sha":null,"homepage":"","language":"Shell","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/neoground.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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":"2023-03-25T22:48:01.000Z","updated_at":"2023-03-29T08:35:31.000Z","dependencies_parsed_at":null,"dependency_job_id":"85be6185-8e28-421c-a434-3ac5918f262e","html_url":"https://github.com/neoground/charm-toolkit","commit_stats":null,"previous_names":["neoground/charm-toolkit"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/neoground%2Fcharm-toolkit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/neoground%2Fcharm-toolkit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/neoground%2Fcharm-toolkit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/neoground%2Fcharm-toolkit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/neoground","download_url":"https://codeload.github.com/neoground/charm-toolkit/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241107357,"owners_count":19910973,"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":["charm-framework","cli","command-line","php"],"created_at":"2024-11-12T05:22:15.453Z","updated_at":"2026-05-09T20:41:59.820Z","avatar_url":"https://github.com/neoground.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# The Bob Toolkit: Universal Charm Framework Manager\n\n![Header Banner](https://neoground.com/data/projects/charm/assets/banner-bob.jpg)\n\nWelcome to the Bob Toolkit, your one-stop-shop for managing \nyour [Charm Framework](https://github.com/neoground/charm) projects like a pro! \nWith just a few keystrokes, Bob can help you create new projects\nand access console commands of your projects easily. \n\nIn a galaxy not so far away, Bob (short for Binary Operations Butler) \nwas created to serve as the ultimate command-line companion for \nCharm Framework developers. Bob needs PHP 8.1 or above.\nIt's so easy to use, even a Wookiee could do it!\n\nRequirements:\n\n- PHP 8.1 or above\n- Composer available in `PATH`\n\n\n## Getting Started\n\nTo begin your epic journey with Bob, just follow these simple steps:\n\n1. Ensure that you have PHP 8.1 or above and Composer installed and available in your system's `PATH`.\n2. Download `bob` and make `bob` executable:\n    ```sh\n   curl -fSsL -o bob https://raw.githubusercontent.com/neoground/charm-toolkit/main/bob \u0026\u0026 chmod +x bob\n    ```\n   If `curl` is not available on your system, you can also download it with `wget`:\n   ```sh\n   wget -O bob https://raw.githubusercontent.com/neoground/charm-toolkit/main/bob \u0026\u0026 chmod +x bob\n    ```\n3. To use bob globally, move it to `/usr/local/bin/`, which should be in your system's `PATH`.\n    ```sh\n   sudo mv bob /usr/local/bin/\n    ```\n4. Execute `bob` from your terminal and watch the magic happen!\n\n\n## Goals of this toolkit\n\nOur mission is to make the Bob Toolkit the ultimate CLI tool for the Charm Framework, \nproviding easy support for all the command-line tasks you'll encounter in your projects. \nWe aim to create a powerful and user-friendly interface that integrates seamlessly \ninto any system, much like how C-3PO's fluency in over six million forms of communication \nmakes him the perfect protocol droid.\n\nWith the Bob Toolkit, we're not only making it easier to manage your Charm projects \nbut also providing you with a faithful companion for your journey through the \ngalaxy of web development. Together, we'll forge a path to bring balance to the \nForce and help you conquer even the most challenging coding challenges.\n\nSo, strap in and prepare for lightspeed as we embark on this adventure with \nthe Bob Toolkit, making your Charm Framework experience out-of-this-world!\n\n\n## Examples\n\n### Create a new project\n\nBob can create new Charm projects faster than a warp-speed \nMillennium Falcon! To create a new project called `holoarchive` in a \nsubdirectory named `holoarchive`, simply run:\n\n```sh\nbob new holoarchive\n```\n\nBob will generate all the necessary files and folders for your \nshiny new `holoarchive` project, and you'll be ready to code in no time.\n\n### Accessing console commands\n\nBob is like the trusty astromech droid R2-D2, always ready to provide \nassistance and perform vital tasks. To access the console commands \nfor your Charm projects, just navigate to the project directory and run:\n\n```sh\nbob command [arguments] [options]\n```\n\nBob will execute the specified command, using any provided arguments \nand options, making it easy to manage your Charm project with just \na few beeps and boops.\n\nFor example, to run the cron jobs for your project, simply execute:\n\n```sh\nbob cron:run\n```\n\nBob will take care of running the scheduled tasks, \njust like R2-D2 maintaining the systems of an X-Wing fighter.\n\n### Development Server\n\nThe `bob` command-line tool offers an incredibly convenient development server \nthat allows you to quickly run and test your Charm applications. \nBy default, the server is set to run on `localhost` and listens to port `8000`.\nIn this section, we'll explore how to use `bob serve` with different parameters to meet your development needs.\n\nThis development server is based on PHP's [built-in web server](https://www.php.net/manual/en/features.commandline.webserver.php).\n\n#### Starting the Development Server\n\nTo start the development server with default settings, simply navigate to your\nCharm project's root directory and execute the following command:\n\n```sh\nbob serve\n```\n\nThis will launch the server on `localhost:8000`. You can now open your favorite browser and visit \n`http://localhost:8000` to interact with your application.\n\n#### Custom host and port\n\nTo specify a custom host, run the following command:\n\n```sh\nbob serve 192.168.0.2\n```\n\nThis will start the server on the `192.168.0.2` IP address and the default port `8000`.\nUse `0.0.0.0` to listen on all interfaces.\n\nTo specify a custom port, run the following command:\n\n```sh\nbob serve localhost 9000\n```\n\nThis will start the server on `localhost` with a custom port `9000`.\n\nTo specify both a custom host and port, run the following command:\n\n```sh\nbob serve 10.0.0.2 9000\n```\n\nThis will start the server on the `10.0.0.2` IP address and the custom port `9000`.\n\n### Self-update\n\nIn a galaxy far, far away, tools need to stay up to date\nto support the Rebellion's cause. That's why Bob comes \nwith a built-in self-update feature. This handy function ensures \nyour toolkit remains in sync with the latest developments \nand improvements, just like a well-maintained hyperdrive system.\n\nTo access this self-update functionality, simply execute the following command:\n\n```sh\nbob self-update\n```\n\nKeep in mind that this command should only be used when Bob is \ninstalled at `/usr/local/bin/bob`. This is the default location \nfor most installations, and the self-update feature is designed \nto work seamlessly with it.\n\nWhen executed, the self-update command fetches the latest version \nof the Bob script from the Charm Framework repository, \nensuring you're always equipped with the most recent tools and fixes. \nThis way, you can continue your quest to build exceptional \nweb applications and help the Rebellion triumph against the\ndark forces of outdated code and inefficient tools.\n\nRemember, a well-updated toolkit is a powerful ally. \nStay sharp and may the Force be with you!\n\n\n## Conclusion\n\nBob is the ultimate toolkit for Charm Framework developers, \noffering a powerful and intuitive way to create and manage projects. \nWith Bob by your side, you'll be the Jedi Master of Charm Framework, \nwielding your coding powers with the grace and wisdom of Yoda himself.\n\nSo, what are you waiting for? Get started with Bob today, \nand may the Force be with you on your Charm Framework journey!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fneoground%2Fcharm-toolkit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fneoground%2Fcharm-toolkit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fneoground%2Fcharm-toolkit/lists"}