{"id":18983864,"url":"https://github.com/conduitplatform/cli","last_synced_at":"2025-04-19T20:13:07.690Z","repository":{"id":36997770,"uuid":"453742587","full_name":"ConduitPlatform/CLI","owner":"ConduitPlatform","description":null,"archived":false,"fork":false,"pushed_at":"2025-04-14T09:34:55.000Z","size":371,"stargazers_count":9,"open_issues_count":1,"forks_count":1,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-04-14T10:37:03.875Z","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":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ConduitPlatform.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":".github/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2022-01-30T17:00:55.000Z","updated_at":"2023-08-10T16:17:04.000Z","dependencies_parsed_at":"2023-11-19T18:43:57.715Z","dependency_job_id":"07f4d9c0-a55d-439e-be91-a491364eb874","html_url":"https://github.com/ConduitPlatform/CLI","commit_stats":{"total_commits":64,"total_committers":5,"mean_commits":12.8,"dds":0.546875,"last_synced_commit":"2922bd94cdbd5416a95efbc5af30c240f001c8fc"},"previous_names":[],"tags_count":13,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ConduitPlatform%2FCLI","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ConduitPlatform%2FCLI/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ConduitPlatform%2FCLI/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ConduitPlatform%2FCLI/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ConduitPlatform","download_url":"https://codeload.github.com/ConduitPlatform/CLI/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249246262,"owners_count":21237014,"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-08T16:18:52.031Z","updated_at":"2025-04-16T13:34:30.432Z","avatar_url":"https://github.com/ConduitPlatform.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n    \u003cbr\u003e\n    \u003ca href=\"https://getconduit.dev\" target=\"_blank\"\u003e\u003cimg src=\"https://getconduit.dev/conduitLogo.svg\" height=\"80px\" alt=\"logo\"/\u003e\u003c/a\u003e\n    \u003cbr/\u003e\n    \u003ch3\u003eThe only Backend you'll ever need.\u003c/h3\u003e\n\u003c/div\u003e\n\n# Conduit CLI\n\nConduit's CLI is a multipurpose tool that's meant to facilitate your development experience and speed up your work\nregardless of whether you're deploying a Conduit instance for your project, developing custom modules or even\ncontributing to the upstream project in your spare time.\n\nIf you treat it right, it's gonna deploy local instances of Conduit for you, provide API client library generation for\nyour frontend team, generate some TypeScript code for your custom modules and even handle your laundry... nah, wait I\nthought we were not actually releasing this one until the next release, right?\n\nAnyway, point is, if you're already using Conduit for your projects or \nsimply intend to give it a ride for the first time, you're most likely going to want to use this.\n\n## Requirements\n\nWhile the use of Docker is not required for every single piece of functionality provided, for most typical use cases\nyou're going to [need Docker installed](https://docs.docker.com/get-docker) and configured so that your user is capable\nof utilizing it without superuser privileges.\u003cbr /\u003e\nFor Linux users, this usually means adding your user to the `docker` group.\n\nYou're also going to need some form of support for [docker compose](https://docs.docker.com/compose/install/).\u003cbr /\u003e\nConduit's CLI supports both v2 and v1. The former comes pre-installed with the latest versions of Docker Desktop.\n\n[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg?style=for-the-badge)](https://oclif.io)\n![npm (scoped)](https://img.shields.io/npm/v/@conduitplatform/cli?style=for-the-badge)\n\n[//]: # ([![Version]\u0026#40;https://img.shields.io/npm/v/conduit-cli.svg\u0026#41;]\u0026#40;https://npmjs.org/package/conduit-cli\u0026#41;)\n\n[//]: # ([![Downloads/week]\u0026#40;https://img.shields.io/npm/dw/conduit-cli.svg\u0026#41;]\u0026#40;https://npmjs.org/package/@conduitplatform/cli\u0026#41;)\n\n[//]: # ([![License]\u0026#40;https://img.shields.io/npm/l/conduit-cli.svg\u0026#41;]\u0026#40;https://github.com/ConduitPlatform/CLI/blob/main/package.json\u0026#41;)\n\n\u003c!-- toc --\u003e\n* [Conduit CLI](#conduit-cli)\n* [Limitations](#limitations)\n* [Usage](#usage)\n* [Commands](#commands)\n* [Roadmap](#roadmap)\n\u003c!-- tocstop --\u003e\n\n# Limitations\n\nWhile the CLI is capable of bootstrapping any Conduit release, including legacy ones,\n `generateSchema` and `generateClient` commands currently require that you target \u003e= v0.14.5.\n\n# Usage\n\u003c!-- usage --\u003e\n```sh-session\n$ npm install -g @conduitplatform/cli\n$ conduit COMMAND\nrunning command...\n$ conduit (--version|-v)\n@conduitplatform/cli/0.0.7 linux-x64 node-v16.15.0\n$ conduit --help [COMMAND]\nUSAGE\n  $ conduit COMMAND\n...\n```\n\u003c!-- usagestop --\u003e\n\n# Commands\n\u003c!-- commands --\u003e\n* [`conduit cli update`](#conduit-cli-update)\n* [`conduit deploy rm`](#conduit-deploy-rm)\n* [`conduit deploy setup`](#conduit-deploy-setup)\n* [`conduit deploy start`](#conduit-deploy-start)\n* [`conduit deploy stop`](#conduit-deploy-stop)\n* [`conduit deploy update`](#conduit-deploy-update)\n* [`conduit generateClient graphql`](#conduit-generateclient-graphql)\n* [`conduit generateClient rest`](#conduit-generateclient-rest)\n* [`conduit generateSchema [PATH]`](#conduit-generateschema-path)\n* [`conduit help [COMMAND]`](#conduit-help-command)\n* [`conduit init`](#conduit-init)\n\n## `conduit cli update`\n\nUpdate your CLI\n\n```\nUSAGE\n  $ conduit cli update\n\nDESCRIPTION\n  Update your CLI\n```\n\n## `conduit deploy rm`\n\nRemove your local Conduit deployment\n\n```\nUSAGE\n  $ conduit deploy rm [--wipe-data] [--defaults]\n\nFLAGS\n  --defaults   Select default values\n  --wipe-data  Wipe data volumes\n\nDESCRIPTION\n  Remove your local Conduit deployment\n```\n\n## `conduit deploy setup`\n\nBootstrap a local Conduit deployment\n\n```\nUSAGE\n  $ conduit deploy setup [--config] [--target \u003cvalue\u003e]\n\nFLAGS\n  --config          Enable manual deployment configuration\n  --target=\u003cvalue\u003e  Specify target tag\n\nDESCRIPTION\n  Bootstrap a local Conduit deployment\n```\n\n## `conduit deploy start`\n\nBring up your local Conduit deployment\n\n```\nUSAGE\n  $ conduit deploy start\n\nDESCRIPTION\n  Bring up your local Conduit deployment\n```\n\n## `conduit deploy stop`\n\nBring down your local Conduit deployment\n\n```\nUSAGE\n  $ conduit deploy stop\n\nDESCRIPTION\n  Bring down your local Conduit deployment\n```\n\n## `conduit deploy update`\n\nUpdate your local Conduit deployment\n\n```\nUSAGE\n  $ conduit deploy update [--config] [--target \u003cvalue\u003e]\n\nFLAGS\n  --config          Enable manual deployment configuration\n  --target=\u003cvalue\u003e  Specify target tag\n\nDESCRIPTION\n  Update your local Conduit deployment\n```\n\n## `conduit generateClient graphql`\n\nGenerate client libraries for your Conduit GraphQL APIs\n\n```\nUSAGE\n  $ conduit generateClient graphql [-t \u003cvalue\u003e] [-p \u003cvalue\u003e]\n\nFLAGS\n  -p, --output-path=\u003cvalue\u003e  Path to store archived library in\n  -t, --client-type=\u003cvalue\u003e  The client type to generate a library for\n\nDESCRIPTION\n  Generate client libraries for your Conduit GraphQL APIs\n```\n\n## `conduit generateClient rest`\n\nGenerate client libraries for your Conduit REST APIs\n\n```\nUSAGE\n  $ conduit generateClient rest [-t \u003cvalue\u003e] [-p \u003cvalue\u003e]\n\nFLAGS\n  -p, --output-path=\u003cvalue\u003e  Path to store archived library in\n  -t, --client-type=\u003cvalue\u003e  The client type to generate a library for\n\nDESCRIPTION\n  Generate client libraries for your Conduit REST APIs\n```\n\n## `conduit generateSchema [PATH]`\n\nGenerate Schema TS files for registered Conduit schemas\n\n```\nUSAGE\n  $ conduit generateSchema [PATH]\n\nDESCRIPTION\n  Generate Schema TS files for registered Conduit schemas\n\nEXAMPLES\n  $ conduit generate-schema\n  ...\n  Generating schemas\n```\n\n_See code: [src/commands/generateSchema.ts](https://github.com/ConduitPlatform/CLI/blob/v0.0.5/src/commands/generateSchema.ts)_\n\n## `conduit help [COMMAND]`\n\nDisplay help for conduit.\n\n```\nUSAGE\n  $ conduit help [COMMAND] [-n]\n\nARGUMENTS\n  COMMAND  Command to show help for.\n\nFLAGS\n  -n, --nested-commands  Include all nested commands in the output.\n\nDESCRIPTION\n  Display help for conduit.\n```\n\n_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.1.12/src/commands/help.ts)_\n\n## `conduit init`\n\nInitialize the CLI to communicate with Conduit\n\n```\nUSAGE\n  $ conduit init [-r]\n\nFLAGS\n  -r, --relogin  Reuses API urls and master key from existing configuration\n\nDESCRIPTION\n  Initialize the CLI to communicate with Conduit\n\nEXAMPLES\n  $ conduit init\n  ...\n  Attempting login\n  Login Successful!\n```\n\n_See code: [src/commands/init.ts](https://github.com/ConduitPlatform/CLI/blob/v0.0.5/src/commands/init.ts)_\n\u003c!-- commandsstop --\u003e\n\n# Roadmap\n* Support more operations (ex. boilerplate code generation)\n* Change generator functions to use a proper engine\n* Support more languages for code generation\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fconduitplatform%2Fcli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fconduitplatform%2Fcli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fconduitplatform%2Fcli/lists"}