{"id":13599157,"url":"https://github.com/sveltinio/sveltin","last_synced_at":"2025-04-10T10:13:59.987Z","repository":{"id":38837802,"uuid":"443153857","full_name":"sveltinio/sveltin","owner":"sveltinio","description":"The Smartest Way to Create SvelteKit powered static websites: a powerful CLI with batteries included","archived":false,"fork":false,"pushed_at":"2023-09-28T14:45:18.000Z","size":2045,"stargazers_count":118,"open_issues_count":8,"forks_count":7,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-03-24T09:05:28.113Z","etag":null,"topics":["cli","cli-app","static-site","static-site-generator","sveltekit","sveltekit-blog","sveltekit-example","sveltekit-tailwindcss","sveltekit-template"],"latest_commit_sha":null,"homepage":"https://sveltin.io","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sveltinio.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","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}},"created_at":"2021-12-30T18:24:36.000Z","updated_at":"2025-01-16T01:14:46.000Z","dependencies_parsed_at":"2023-09-28T16:25:11.166Z","dependency_job_id":null,"html_url":"https://github.com/sveltinio/sveltin","commit_stats":null,"previous_names":[],"tags_count":51,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sveltinio%2Fsveltin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sveltinio%2Fsveltin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sveltinio%2Fsveltin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sveltinio%2Fsveltin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sveltinio","download_url":"https://codeload.github.com/sveltinio/sveltin/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248198892,"owners_count":21063628,"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":["cli","cli-app","static-site","static-site-generator","sveltekit","sveltekit-blog","sveltekit-example","sveltekit-tailwindcss","sveltekit-template"],"created_at":"2024-08-01T17:01:00.352Z","updated_at":"2025-04-10T10:13:59.964Z","avatar_url":"https://github.com/sveltinio.png","language":"Go","funding_links":[],"categories":["cli","Meta-Meta"],"sub_categories":["The _How To's?_"],"readme":"\u003ch1 align=\"center\"\u003e\n    \u003cimg src=\"resources/sveltin-logo.png\" width=\"224px\" alt=\"sveltin logo\"/\u003e\n\u003c/h1\u003e\n\u003ch2 align=\"center\"\u003e\nThe Smartest Way to Create SvelteKit powered static websites.\n\u003c/h2\u003e\n\u003cp align=\"center\"\u003e\n\u003ca href=\"https://sveltin.io/\" target=\"_blank\"\u003e\n        Homepage\n    \u003c/a\u003e |\n    \u003ca href=\"https://docs.sveltin.io/release-notes\" target=\"_blank\"\u003e\n        Release Notes\n    \u003c/a\u003e |\n    \u003ca href=\"https://docs.sveltin.io/quick-start\" target=\"_blank\"\u003e\n        Quick Start\n    \u003c/a\u003e |\n    \u003ca href=\"https://docs.sveltin.io/\" target=\"_blank\"\u003e\n        Documentation\n    \u003c/a\u003e |\n    \u003ca href=\"https://github.com/sveltinio/sveltin/blob/main/CONTRIBUTING.md\" target=\"_blank\"\u003e\n        Contributing\n    \u003c/a\u003e\n\u003c/p\u003e\n\u003cp align=\"center\"\u003e\n    \u003ca href=\"https://github.com/sveltinio/sveltin/blob/main/LICENSE\" target=\"_blank\"\u003e\n        \u003cimg src=\"https://img.shields.io/badge/license-apache_2.0-blue?style=flat-square\u0026logo=none\" alt=\"license\" /\u003e\n    \u003c/a\u003e\n    \u0026nbsp;\n     \u003ca href=\"https://goreportcard.com/report/github.com/sveltinio/sveltin/\" target=\"_blank\"\u003e\n        \u003cimg src=\"https://goreportcard.com/badge/github.com/sveltinio/sveltin\" alt=\"go report card\" /\u003e\n    \u003c/a\u003e\n    \u0026nbsp;\n    \u003ca href=\"https://pkg.go.dev/github.com/sveltinio/sveltin/\" target=\"_blank\"\u003e\n        \u003cimg src=\"https://pkg.go.dev/badge/github.com/sveltinio/sveltin/.svg\" alt=\"go reference\" /\u003e\n    \u003c/a\u003e\n    \u0026nbsp;\n    \u003ca href=\"https://github.com/sveltinio/sveltin/releases\" target=\"_blank\"\u003e\n        \u003cimg src=\"https://img.shields.io/badge/version-v0.11.0-success?style=flat-square\u0026logo=none\" alt=\"sveltin cli version\" /\u003e\n    \u003c/a\u003e\n    \u0026nbsp;\n    \u003ca href=\"https://github.com/sveltinio/sveltin/actions/workflows/release.yml\" target=\"_blank\"\u003e\n        \u003cimg src=\"https://github.com/sveltinio/sveltin/actions/workflows/release.yml/badge.svg\" alt=\"CI\" /\u003e\n    \u003c/a\u003e\n    \u0026nbsp;\n    \u003ca href=\"https://madewithsvelte.com/p/sveltin/shield-link\" target=\"_blank\"\u003e\n        \u003cimg src=\"https://madewithsvelte.com/storage/repo-shields/3613-shield.svg\" alt=\"made with svelte shield\" /\u003e\n    \u003c/a\u003e\n\u003c/p\u003e\n\n# Sveltin\n\nSveltin is a CLI (Command Line Interface) created to boost the developers productivity working on \u003cstrong\u003eSvelteKit v1.x.x powered static websites\u003c/strong\u003e.\n\n## :information_source: SvelteKit versions\n\n\u003e Latest tested SvelteKit version is [1.8.3](https://github.com/sveltejs/kit/releases/tag/%40sveltejs%2Fkit%401.8.3). SvelteKit reached v1.x.x then no more breakings are expected until a new major release. Although we decided to stay sticked to the tested version, you should be able to upgrade SvelteKit to the upcoming minor versions without disruptions\n\n## :mega: Overview\n\nSveltin is a simple, quick and powerful CLI to:\n\n- Scaffold SvelteKit powered websites\n- Generate resources, libs and endpoints\n- Add content to the resources\n- Generate menu structure, sitemap and rss\n- Make your site SEO Ready (Metadata, Json-LD, OpenGraph) in a easy way\n\nSveltin provides:\n\n- Out-of-the-box support for vanilla CSS, Sass/SCSS, Tailwind CSS, Bulma and Bootstrap\n- Ready to use Svelte [components](https://github.com/sveltinio/sveltin-components-library)\n\n## :rocket: Quick Start\n\nWith few commands Sveltin flex the muscles 💪\n\n\u003e **NOTE**: each command can be executed in interactive way so do not need to pass arguments and flags to it.\n\n```bash\n# Create a project with TailwindCSS support\nsveltin init myBlog --css tailwindcss\n\n# Move to the project folder\ncd myBlog\n\n# Install all the dependencies\nsveltin install\n\n# Create a public page and compose it with Svelte\n# (http://localhost:5173/contact)\nsveltin new page contact --svelte\n\n# Create a public page and compose it with Markdown\n# (http://localhost:5173/about)\nsveltin new page about --markdown\n\n# Create a 'posts' resource\nsveltin new resource posts\n\n# Add new content to the posts resource\n# (http://localhost:5173/posts/getting-started)\nsveltin add content getting-started --to posts\n\n# Add a 'category' metadata\n# (http://localhost:5173/posts/category)\nsveltin add metadata category --to posts --as single\n\n# Run the server\nsveltin server\n```\n\n## :book: Documentation\n\nPlease see the [documentation](https://docs.sveltin.io) for more information about Sveltin.\n\n## :computer: Installation\n\n### :wrench: Prerequisites\n\n- Git\n- Node (v16.9.0 or higher is required)\n\n### OSX and Linux via Homebrew\n\nHomebrew will also install Git and Node.\n\n```bash\n# Tap a new formula:\nbrew tap sveltinio/sveltin\n\n# Install:\nbrew install sveltin\n```\n\n### Windows via Scoop\n\n```bash\n# Tap a new bucket:\nscoop bucket add sveltinio https://github.com/sveltinio/scoop-sveltin.git\n\n# Install:\nscoop install sveltinio/sveltin\n```\n\n### Go Install\n\nInstallation is done by using the `go install` command. In this case, ensure to have **Go (v1.17 or higher) installed** on your machine:\n\n```bash\ngo install github.com/sveltinio/sveltin@latest\n```\n\n### Manually\n\nYou can download the pre-compiled binary for you specific OS from the [releases page](https://github.com/sveltinio/sveltin/releases). You will need to copy the and extract the binary, then move it to your local bin folder. Please, refer to the example below:\n\n```bash\ncurl https://github.com/sveltinio/sveltin/releases/download/${VERSION}/${PACKAGE_NAME} -o ${PACKAGE_NAME}\nsudo tar -xvf ${PACKAGE_NAME} -C /usr/local/bin/\nsudo chmod +x /usr/local/bin/sveltin\n```\n\n## :gear: CLI Commands \u0026 Options\n\nsveltin comes with a set of commands and subcommands to help dealing with your SvelteKit project.\n\nEach command can be executed with inline arguments or interactivly.\n\n```bash\n$ sveltin -h\n\nsveltin is the main command to work with SvelteKit powered static website.\n\nUsage:\n  sveltin [command]\n\nAvailable Commands:\n  add         Add content and metadata to a resource\n  build       Builds a production version of your static website\n  completion  Generate the autocompletion script for the specified shell\n  deploy      Deploy the website over FTP\n  generate    Generate static files (sitemap, rss, menu)\n  help        Help about any command\n  init        Initialize a new sveltin project\n  install     Install the project dependencies\n  migrate     Migrate existing sveltin project files to the latest sveltin version ones\n  new         Create nee resources, pages and themes\n  preview     Preview the production version locally\n  server      Run the development server\n  update      Update your project dependencies\n\nFlags:\n  -h, --help      help for sveltin\n  -v, --version   version for sveltin\n\nUse \"sveltin [command] --help\" for more information about a command.\n```\n\n### sveltin init\n\n`sveltin init` is the main command to scaffold a project.\n\nAlias: `create`\n\nRead more [here][init].\n\n### sveltin new\n\n`sveltin new` is the main command to generate pages, resources (routes) and themes for your project.\n\nAlias: `n`\n\n\u003cdetails\u003e\n    \u003csummary\u003e(Click to expand the list of available subcommands)\u003c/summary\u003e\n\n| Subcommand     | Aliases | Description                          |\n| :------------- | :-----: | :----------------------------------- |\n| [new-page]     |    p    | Command to create a new public page. |\n| [new-resource] |    r    | Command to create a new resource.    |\n\n\u003c/details\u003e\n\nRead more [here][new].\n\n### sveltin add\n\n`sveltin add` is the main command to add content and metadata to existing resources.\n\nAlias: `a`\n\n\u003cdetails\u003e\n    \u003csummary\u003e(Click to expand the list of available subcommands)\u003c/summary\u003e\n\n| Subcommand     | Aliases | Description                                                            |\n| :------------- | :-----: | :--------------------------------------------------------------------- |\n| [add-content]  |    c    | Command to create a new content for existing resource.                 |\n| [add-metadata] |    m    | Command to add a new metadata to your content as a Sveltekit resource. |\n\n\u003c/details\u003e\n\nRead more [here][add].\n\n### sveltin generate\n\n`sveltin generate` is used to generate static files like sitemap, menu structure or rss feed file.\n\nAlias: `g`\n\n\u003cdetails\u003e\n    \u003csummary\u003e(Click to expand the list of avilable subcommands)\u003c/summary\u003e\n\n| Subcommand         | Description                    |\n| :----------------- | :----------------------------- |\n| [generate-menu]    | Generate the menu config file. |\n| [generate-sitemap] | Generate a sitemap.xml.        |\n| [generate-rss]     | Generate a rss.xml file.       |\n\n\u003c/details\u003e\n\nRead more [here][generate].\n\n### sveltin install\n\n`sveltin install` is used to initialize the Sveltin project getting all depencencies from the `package.json` file.\n\nAlias: `i`\n\nRead more [here][install].\n\n### sveltin update\n\n`sveltin update` is used to update all depencencies from the `package.json` file.\n\nRead more [here][update].\n\n### sveltin migrate\n\n`sveltin migrate` is used to migrate existing sveltin project files to the latest Sveltin version ones.\n\nRead more [here][migrate].\n\n### sveltin server\n\n`sveltin server` is used to run the VITE server. It wraps svelte-kit defined commands to run the server.\n\nAlias: `s`, `serve`, `run`, `dev`\n\nRead more [here][server].\n\n### sveltin build\n\n`sveltin build` is used to build a production version of your static website. It wraps `sveltekit-build` command.\n\nAlias: `b`\n\nRead more [here][build].\n\n### sveltin preview\n\n`sveltin preview` is used to run a preview for the production version locally.\n\nRead more [here][preview].\n\n### sveltin deploy\n\n`sveltin deploy` is used to deploy your website over FTP on your hosting platform.\n\nRead more [here][deploy].\n\n### sveltin completion\n\n`sveltin completion` generates the autocompletion script for the specified shell (bash|zsh|fish|powershell).\n\nRead more [here][completion].\n\n## :bulb: Contributing\n\nContribution of any kind including documentation, themes, tutorials, blog posts, bug reports, issues, feature requests, feature implementations, pull requests are more than welcome.\n\nRead more [here][contributing].\n\n## Dependencies\n\nSveltin leverages many great open source libraries:\n\n| Name                                                    | Version   | License      |\n| :------------------------------------------------------ | :-------: | :----------- |\n| [bubble](https://github.com/charmbracelet/bubbles)      | `0.16.1`  | MIT          |\n| [bubbletea](https://github.com/charmbracelet/bubbletea) | `0.24.1`  | MIT          |\n| [lipgloss](https://github.com/charmbracelet/lipgloss)   | `0.8.0`   | MIT          |\n| [validator](https://github.com/go-playground/validator) | `10.15.4` | MIT          |\n| [slug](https://github.com/gosimple/slug)                | `1.13.1`  | MPL-2.0      |\n| [ftp](https://github.com/jlaffaye/ftp)                  | `0.2.0`   | ISC          |\n| [is](https://github.com/matryer/is)                     | `1.4.1`   | MIT          |\n| [afero](https://github.com/spf13/afero)                 | `1.10.0`   | Apache-2.0   |\n| [cobra](https://github.com/spf13/cobra)                 | `1.7.0`   | Apache-2.0   |\n| [viper](https://github.com/spf13/viper)                 | `1.26.0`  | MIT          |\n| [prompti](https://github.com/sveltinio/prompti)         | `0.2.5`   | MIT          |\n| [gjson](https://github.com/tidwall/gjson)               | `1.7.0`  | MIT          |\n| [sjson](https://github.com/tidwall/sjson)               | `1.2.5`   | MIT          |\n| [text](https://golang.org/x/text)                       | `0.13.0`   | BSD-3-Clause |\n\n## :free: License\n\nSveltin is free and open-source software licensed under the Apache 2.0 License.\n\n[add]: https://docs.sveltin.io/cli/add/\n[add-content]: https://docs.sveltin.io/cli/add-content/\n[add-metadata]: https://docs.sveltin.io/cli/add-metadata/\n[build]: https://docs.sveltin.io/cli/build/\n[completion]: https://docs.sveltin.io/cli/completion/\n[contributing]: CONTRIBUTING.md\n[deploy]: https://docs.sveltin.io/cli/deploy/\n[generate]: https://docs.sveltin.io/cli/generate/\n[generate-menu]: https://docs.sveltin.io/cli/generate-menu/\n[generate-rss]: https://docs.sveltin.io/cli/generate-rss/\n[generate-sitemap]: https://docs.sveltin.io/cli/generate-sitemap/\n[init]: https://docs.sveltin.io/cli/init/\n[install]: https://docs.sveltin.io/cli/install/\n[migrate]: https://docs.sveltin.io/cli/migrate/\n[new]: https://docs.sveltin.io/cli/new/\n[new-page]: https://docs.sveltin.io/cli/new-page/\n[new-resource]: https://docs.sveltin.io/cli/new-resource/\n[preview]: https://docs.sveltin.io/cli/preview/\n[server]: https://docs.sveltin.io/cli/server/\n[update]: https://docs.sveltin.io/cli/update/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsveltinio%2Fsveltin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsveltinio%2Fsveltin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsveltinio%2Fsveltin/lists"}