{"id":13574206,"url":"https://github.com/elementor/lokl-cli","last_synced_at":"2025-05-07T12:55:19.549Z","repository":{"id":50929763,"uuid":"264678147","full_name":"elementor/lokl-cli","owner":"elementor","description":"Interactive script to launch and manage your Lokl sites","archived":false,"fork":false,"pushed_at":"2021-06-01T10:05:03.000Z","size":183,"stargazers_count":65,"open_issues_count":14,"forks_count":7,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-05-07T12:55:13.259Z","etag":null,"topics":["strattic"],"latest_commit_sha":null,"homepage":null,"language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"unlicense","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/elementor.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-05-17T13:52:52.000Z","updated_at":"2025-03-11T17:48:24.000Z","dependencies_parsed_at":"2022-08-25T10:31:30.838Z","dependency_job_id":null,"html_url":"https://github.com/elementor/lokl-cli","commit_stats":null,"previous_names":["elementor/lokl-cli"],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/elementor%2Flokl-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/elementor%2Flokl-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/elementor%2Flokl-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/elementor%2Flokl-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/elementor","download_url":"https://codeload.github.com/elementor/lokl-cli/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252882793,"owners_count":21819155,"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":["strattic"],"created_at":"2024-08-01T15:00:48.108Z","updated_at":"2025-05-07T12:55:19.529Z","avatar_url":"https://github.com/elementor.png","language":"Shell","funding_links":[],"categories":["Shell"],"sub_categories":[],"readme":"lokl-cli\n========\n\nInteractive wizard or noninteractive script for launching and managing your [lokl](https://lokl.dev) WordPress sites.\n\nUsage\n=====\n\n### macOS, Linux, Windows\n\nThe simplest way to get started, paste the following into a terminal to launch Lokl's interactive wizard:\n\n`sh -c \"$(curl -sSl 'https://lokl.dev/cli-5.0.0')\"`\n\n### Site templates\n\nFrom version 5.0.0, Lokl now supports site template files, which, if present, Lokl will allow you to choose as a template for your new site. They're totally optional, Lokl runs just fine without them. \n\nCurrently, these allow specifying directories from your host machine to mount within your Lokl site's container. This makes it easier for those editing plugins/themes/site files on their local computer and having the changes apply immediately within their Lokl site.\n\nFuture enhancements to this templating will allow for things like specifying different sets of plugins/themes to auto-install in new Lokl sites.\n\nAn example site template file is located within this repository, named `site-template-example.lokl`. There are comments in this template, describing how to use it, also described here:\n\n - make a `templates` directory inside a `.lokl` directory in your `$HOME` folder.\n\nie, on macOS, this would be `/Users/leon/.lokl/templates`\n\n - copy the example `site-template-example.lokl` template from this repository into that Lokl templates folder, naming it something descriptive\n - edit the volumes section to specify which directories you want to be shared from your host operating system to within the container running your Lokl site\n - when you next run the Lokl CLI wizard to create a site, you'll be presented with a list of your templates to choose from\n\n#### Programmatic usage\n\nIf you're familiar with Docker and bash, you can read through the source code of this repository and the [lokl](https://github.com/leonstafford/lokl)'s to see how I provision and control Lokl. \n\nAny docs I write about that will be quickly out of date, so please refer to the code and ask me any specific questions.\n\n\nBuild status\n============\n\n[![CircleCI](https://circleci.com/gh/leonstafford/lokl-cli.svg?style=svg)](https://circleci.com/gh/leonstafford/lokl-cli)\n\nTesting\n=======\n\n - `shellcheck`\n - `shellspec`\n\nWith code coverage report:\n\n - `shellspec --kcov`\n\nFor convenience, you can run `sh test.sh`.\n\nCircleCI config runs both of these commands.\n\nDebug log\n=========\n\nTo aid in development or user support, lokl-cli appends to a log file\n in your system's temp directory, which can be followed by:\n\n`touch /tmp/lokldebuglog \u0026\u0026 tail -F /tmp/lokldebuglog`\n\nStyle Guide\n===========\n\nIn lieu of an automatic beautifier, refer to [Google Shellguide](https://google.github.io/styleguide/shellguide.html) if unsure. If you know of something like PHPCodeSniffer and PHPCodeBeautifier to compliment ShellCheck, please let me know!\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Felementor%2Flokl-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Felementor%2Flokl-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Felementor%2Flokl-cli/lists"}