{"id":20631172,"url":"https://github.com/solidlabresearch/solid-sdx-cli","last_synced_at":"2025-10-25T11:03:58.824Z","repository":{"id":208438004,"uuid":"716564493","full_name":"SolidLabResearch/solid-sdx-cli","owner":"SolidLabResearch","description":null,"archived":false,"fork":false,"pushed_at":"2023-11-30T11:53:28.000Z","size":2187,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-09-27T21:28:57.142Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","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/SolidLabResearch.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"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-11-09T12:01:48.000Z","updated_at":"2023-11-09T12:27:16.000Z","dependencies_parsed_at":"2023-11-30T10:24:57.241Z","dependency_job_id":"2e108e9c-adb7-4236-aed4-edcd36575b8a","html_url":"https://github.com/SolidLabResearch/solid-sdx-cli","commit_stats":null,"previous_names":["solidlabresearch/solid-sdx-cli"],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/SolidLabResearch/solid-sdx-cli","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SolidLabResearch%2Fsolid-sdx-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SolidLabResearch%2Fsolid-sdx-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SolidLabResearch%2Fsolid-sdx-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SolidLabResearch%2Fsolid-sdx-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SolidLabResearch","download_url":"https://codeload.github.com/SolidLabResearch/solid-sdx-cli/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SolidLabResearch%2Fsolid-sdx-cli/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":280943395,"owners_count":26417747,"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","status":"online","status_checked_at":"2025-10-25T02:00:06.499Z","response_time":81,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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-16T14:11:23.055Z","updated_at":"2025-10-25T11:03:58.780Z","avatar_url":"https://github.com/SolidLabResearch.png","language":"TypeScript","readme":"# Solid SDX CLI\n\nThe Solid Development eXperience CLI is meant to bootstrap Solid application development in JS/TS.\n\n## Main Features\n\n- Bootstrap your application work directory\n- Search the [SolidLab Catalog](https://catalog.solidlab.be) for shapes via CLI\n- Install shape packages from the [SolidLab Catalog](https://catalog.solidlab.be) via CLI\n- Generate a (SDL) GraphQL Schema\n- Generate TS type information for intellisense support in your favorite IDE\n- Generate a client proxy to read/write to (remote) Pods\n\n\n## Installation\n\nGlobally installing allows you to use `sdx` as a CLI binary.\n_Requires at least node 18.0.0__\n\n```bash\nnpm i -g @solidlab/solid-sdx-cli\n```\n\n## Usage\n\n```bash\n# Print out the options in CLI\nsdx help\n```\n\n### Init workspace\n\nInitializes a workspace for Solid Application Development.\n\n```bash\nsdx init [--force] [--noLibs] [name]\n```\n\nYou can provide an optional name for your project. If omitted, it will be asked through the interactive shell prompt.\n\n**Parameters**\n\n- `--force`: If a `package.json`` already exists, use `--force` to merge setup into the existing `package.json`\n- `--noLibs`: By default extra libraries that are needed will be installed, if for some reason you don't want this, you can use this trigger.\n\nInitialisation will write three important files:\n\n* `.solidmanifest`: manifest of your application\n* `.sdxconfig`: config file for the sdx toolkit\n* `package.json`: starting package.json for this project\n\n### Search type packages\n\nSearch for a Solid type package.\n\n```bash\nsdx search [query]\n```\n\nWill search the central SolidLab Catalog for potential matches.\n\n### Install shape package\n\nInstall a Solid shape package.\n\n```bash\nsdx install package [UriOrIndex]\n// or\nsdx package install [UriOrIndex]\n```\n\nInstall a shape package into your local project. It will be added to the .solidmanifest file and will - by default - update the generated GraphQL Schema (and generated sdk if applicable).\nA full URI can be used, or the index from the latest results table generated by the cli (eg. from `sdx search`).\n\n### Uninstall shape package\n\nInstall a Solid shape package.\n\n```bash\nsdx uninstall package [UriOrIndex]\n// or\nsdx package uninstall [UriOrIndex]\n```\n\nUninstall a shape package from your local project. It will be removed from the .solidmanifest file and will - by default - update the generated GraphQL Schema (and generated sdk if applicable).\nA full URI can be used, or the index from the latest results table generated by the cli (eg. from `sdx list packages`).\n\n### List shape packages\n\nList all installed Solid shape packages.\n\n```bash\nsdx list packages\n// or\nsdx packages list\n```\n\nLists all installed shape packages.\n\n### Generate schema\n\nManually trigger GraphQL Schema generation, based on the installed shape packages.\n\n```bash\nsdx generate schema\n```\n\nThe GraphQL Schema will be used to generate typings and a Sdk SolidClient class.\n\n### Generate typings\n\nManually trigger generation of typings, based on the installed shape packages.\n\n```bash\nsdx generate typings\n```\n\nThe generated typings can be used by an IDE for intellisense autocompletion and strong typing language support.\n\n\n### Generate sdk client\n\nManually trigger a SolidClient sdk client, based on the generated GraphQL Schema and the user-created GraphQL Queries in the `src/gql/` folder.\n\n```bash\nsdx generate sdk\n```\n\nThe generated Sdk Client can then be used with the @solidlab/solid-sdx-ts library to interface with accessible pods.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsolidlabresearch%2Fsolid-sdx-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsolidlabresearch%2Fsolid-sdx-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsolidlabresearch%2Fsolid-sdx-cli/lists"}