{"id":21401472,"url":"https://github.com/spoonx/swan-cli","last_synced_at":"2025-07-13T21:31:50.118Z","repository":{"id":65507681,"uuid":"49330624","full_name":"SpoonX/swan-cli","owner":"SpoonX","description":"The cli for swan","archived":false,"fork":false,"pushed_at":"2017-10-02T07:58:24.000Z","size":50,"stargazers_count":12,"open_issues_count":3,"forks_count":3,"subscribers_count":6,"default_branch":"master","last_synced_at":"2024-04-25T22:01:59.586Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","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/SpoonX.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":"2016-01-09T15:59:40.000Z","updated_at":"2020-08-15T20:57:32.000Z","dependencies_parsed_at":"2023-01-26T15:45:32.336Z","dependency_job_id":null,"html_url":"https://github.com/SpoonX/swan-cli","commit_stats":null,"previous_names":["swanstack/cli"],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SpoonX%2Fswan-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SpoonX%2Fswan-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SpoonX%2Fswan-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SpoonX%2Fswan-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SpoonX","download_url":"https://codeload.github.com/SpoonX/swan-cli/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225919559,"owners_count":17545285,"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":[],"created_at":"2024-11-22T15:27:59.554Z","updated_at":"2024-11-22T15:28:00.126Z","avatar_url":"https://github.com/SpoonX.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Swan CLI\n*The command line interface for SWAN.*\n\n**Unmaintained! This setup requires an overhaul, which won't happen any time soon.**\n\nSWAN as a stack runs [**S**ails](http://sailsjs.org/), [**W**aterline](https://github.com/balderdashy/waterline), [**A**urelia](http://aurelia.io) and [**N**ode](https://nodejs.org).\n\n**Note:** This module is work in progress.\nIt already provides some useful methods, but isn't _done_ yet.\nContributions are more than welcome.\n\n## What?\nThe SWAN stack makes developing applications a lot easier and faster. It follows the following principles:\n\n- **Separate repositories:** The project, the API and the client live in separate repositories.\n- **API-driven development:** Separation of client (static files) and server (API).\n- **Single entity definition:** Entities (and thus API endpoints) are the same on both the server and the client, including validation.\n\n## Installation\n\n1. Install swan and the other dependencies: `npm i -g sails jspm gulp swan-cli`\n2. Create a [personal access token](https://github.com/settings/tokens) on github and set permissions for `repo`.\n3. Type `swan configure` and follow the steps.\n4. Enjoy!\n\n## Usage\nUsage is described in the `swan --help` output.\n\n#### New project\nTo create a new project.\n\n```\nswan new projectname\n```\n\n#### Configuring project\nConfigure default settings such as personal access token and protocols (ssh/https). Switching protocols in a swan project will update all the remotes.\n\n```\nswan configure\n```\n\n#### Collaborate on existing project\nTo start working on, or check out a project.\n\n```\nswan setup owner/repository\n```\n\nFor instance `swan setup spoonx/aurelia-todo`.\n\n#### Start your project\nStart your project. This starts both the server, and the client in one convenient command.\n\n```\nswan start --v\n```\n\n## Configuration\nSwan can be configured by changing the contents of the `swan.json` file.\n\n## Coming soon(ish)\n* Getting started\n* Swan install (to quickly set up your project after cloning).\n* Support for mobile.\n\n## Disclaimer\nThis project is a little bit messy. It's relatively easy to get into, but it could be structured much better.\nThis is the first version, meant as a PoC to figure out what works best for SWAN.\nThis means it _will_ be refactored at some point, but the usage will most likely stay the same.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fspoonx%2Fswan-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fspoonx%2Fswan-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fspoonx%2Fswan-cli/lists"}