{"id":18565216,"url":"https://github.com/rigetti/qcs-cli","last_synced_at":"2025-04-10T04:32:30.803Z","repository":{"id":34380947,"uuid":"175247066","full_name":"rigetti/qcs-cli","owner":"rigetti","description":"The Rigetti Quantum Cloud Services Command Line Interface (CLI)","archived":false,"fork":false,"pushed_at":"2022-12-09T00:55:23.000Z","size":942,"stargazers_count":8,"open_issues_count":17,"forks_count":4,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-18T12:38:32.771Z","etag":null,"topics":["cloud","command-line","quantum-computing","typescript"],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","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/rigetti.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":"2019-03-12T15:50:48.000Z","updated_at":"2023-03-28T06:05:39.000Z","dependencies_parsed_at":"2023-01-15T06:43:00.762Z","dependency_job_id":null,"html_url":"https://github.com/rigetti/qcs-cli","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rigetti%2Fqcs-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rigetti%2Fqcs-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rigetti%2Fqcs-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rigetti%2Fqcs-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rigetti","download_url":"https://codeload.github.com/rigetti/qcs-cli/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248157616,"owners_count":21057042,"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":["cloud","command-line","quantum-computing","typescript"],"created_at":"2024-11-06T22:17:57.355Z","updated_at":"2025-04-10T04:32:30.427Z","avatar_url":"https://github.com/rigetti.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# qcs-cli\n\nThe `qcs-cli` is the Rigetti Quantum Cloud Services Command Line Interface (CLI). It is used for:\n\n- Reserving, viewing, or cancelling your reservations on Rigetti Quantum Computers,\n- Listing available Quantum Computers (devices) and various sublattices within them.\n- Viewing, creating and deleting your Quantum Machine Images (QMIs).\n\n```\n$ qcs\n\nThe Rigetti QCS Command Line Interface (CLI)\n\nUSAGE\n  $ qcs [COMMAND]\n\nCOMMANDS\n  cancel        Cancel reservations in the compute schedule.\n  devices       View available QPU devices.\n  help          display help for qcs\n  lattices      View available lattices.\n  qmis          View, create, and delete QMIs.\n  reservations  View the compute block schedule.\n  reserve       Book reservations in the compute schedule.\n```\n\nEvery QCS User's QMI comes preinstalled with the `qcs-cli`. It may also be\nused locally from your laptop. Installation and setup instructions may be found below.\n\n## Installation \u0026 Setup\n\n### Pre-reqs: Install `node` \u0026 `npm`\n\nThe qcs-cli is written in typescript, which requires node and the node package manager npm to be\ninstalled. Install both from this [link](https://nodejs.org/en/). If node is already on your\nmachine, make sure you have version \u003e `8.0.0`.\n\n### Install qcs-cli\n\n#### Install via `npm`\n\nRun the command npm `install -g qcs-cli`.\n\n#### Install via the source from github\n\nClone this repository to your machine via the following command:\n\n```\n# Clone the repo and cd into it\ngit clone git@github.com:rigetti/qcs-cli.git\ncd qcs-cli\n\n# Install qcs-cli\nnpm install\n\n# Link the qcs command so you can type qcs\nnpm link\n```\n\n### Setup\n\nThe qcs-cli is ready to use to view available devices and lattices. To book and view reservations\nwith the qcs-cli, and to manage quantum machine images, however, you will need to authenticate as a\nuser. To do this, a `.qcs_config` file with the following contents must be placed in the home folder\n(`~`) of your machine. The contents of `~/.qcs_config` should be the following:\n\n```\n[Rigetti Forest]\nurl = https://forest-server.qcs.rigetti.com\nuser_id = \u003cyour-user-token\u003e\n```\n\nYour `user_id` can be found in the `.qcs_config` file in your QMI, if you have already registered\nfor QCS. If you haven't signed up for QCS, you can request access\n[here](https://qcs.rigetti.com/request-access).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frigetti%2Fqcs-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frigetti%2Fqcs-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frigetti%2Fqcs-cli/lists"}