{"id":25371183,"url":"https://github.com/nucleuscloud/setup-neosync-cli-action","last_synced_at":"2026-02-25T13:05:32.366Z","repository":{"id":210750296,"uuid":"727367639","full_name":"nucleuscloud/setup-neosync-cli-action","owner":"nucleuscloud","description":"Sets up Neosync CLI in your GitHub Actions workflow.","archived":false,"fork":false,"pushed_at":"2025-02-03T19:48:39.000Z","size":1335,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-02-03T20:28:43.534Z","etag":null,"topics":["cli","github-action","neosync"],"latest_commit_sha":null,"homepage":"https://www.neosync.dev","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/nucleuscloud.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-12-04T18:14:47.000Z","updated_at":"2025-02-03T19:47:18.000Z","dependencies_parsed_at":"2023-12-06T21:27:56.258Z","dependency_job_id":"abd3ce1f-fbe1-4761-90f2-f573813b7082","html_url":"https://github.com/nucleuscloud/setup-neosync-cli-action","commit_stats":null,"previous_names":["nucleuscloud/setup-neosync-cli-action"],"tags_count":9,"template":false,"template_full_name":"actions/typescript-action","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nucleuscloud%2Fsetup-neosync-cli-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nucleuscloud%2Fsetup-neosync-cli-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nucleuscloud%2Fsetup-neosync-cli-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nucleuscloud%2Fsetup-neosync-cli-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nucleuscloud","download_url":"https://codeload.github.com/nucleuscloud/setup-neosync-cli-action/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":238937501,"owners_count":19555376,"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","github-action","neosync"],"created_at":"2025-02-15T02:32:43.325Z","updated_at":"2025-10-28T18:37:08.078Z","avatar_url":"https://github.com/nucleuscloud.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Setup Neosync CLI Action\n\n[![GitHub Super-Linter](https://github.com/nucleuscloud/setup-neosync-cli-action/actions/workflows/linter.yml/badge.svg)](https://github.com/super-linter/super-linter)\n![CI](https://github.com/nucleuscloud/setup-neosync-cli-action/actions/workflows/ci.yml/badge.svg)\n[![Check dist/](https://github.com/nucleuscloud/setup-neosync-cli-action/actions/workflows/check-dist.yml/badge.svg)](https://github.com/nucleuscloud/setup-neosync-cli-action/actions/workflows/check-dist.yml)\n[![CodeQL](https://github.com/nucleuscloud/setup-neosync-cli-action/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/nucleuscloud/setup-neosync-cli-action/actions/workflows/codeql-analysis.yml)\n[![Coverage](./badges/coverage.svg)](./badges/coverage.svg)\n\nThe `nucleuscloud/setup-neosync-cli-action` is a TypeScript action that sets up\nNeosync CLI in your GitHub Actions workflow.\n\n- Downloads a specific version of Neosync CLI and adds it to the `PATH`.\n\nAfter you've used the action, subsequent steps in the same job can run Nucleus\ncommands using\n[the GitHub Actions `run` syntax](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun).\nThis allows Neosync commands to work like they do on your local command-line.\n\n## Usage\n\n### Neosync CLI\n\n#### Download the latest Neosync CLI\n\n```yaml\nname: ci\n\non:\n  push:\n    branches: main\n\njobs:\n  whoami:\n    runs-on: ubuntu-latest\n    steps:\n      - name: Download Neosync CLI\n        uses: nucleuscloud/setup-neosync-cli-action@v1\n      - name: Whoami\n        run: neosync whoami\n        env:\n          NEOSYNC_API_URL: \u003curl\u003e\n```\n\n#### Download Neosync CLI at a specific version\n\n```yaml\nname: ci\n\non:\n  push:\n    branches: main\n\njobs:\n  whoami:\n    runs-on: ubuntu-latest\n    steps:\n      - name: Download Neosync CLI\n        uses: nucleuscloud/setup-neosync-cli-action@v1\n        with:\n          version: v0.0.18\n      - name: Whoami\n        run: neosync whoami\n        env:\n          NEOSYNC_API_URL: \u003curl\u003e\n```\n\n#### Provide a Neosync API Key\n\n```yaml\nname: ci\n\non:\n  push:\n    branches: main\n\njobs:\n  whoami:\n    runs-on: ubuntu-latest\n    steps:\n      - name: Download Neosync CLI\n        uses: nucleuscloud/setup-neosync-cli-action@v1\n      - name: Whoami\n        run: neosync whoami\n        env:\n          NEOSYNC_API_URL: \u003curl\u003e\n          NEOSYNC_API_KEY: ${{ secrets.NEOSYNC_API_KEY }}\n```\n\n## Customizing\n\n### inputs\n\n| Name      | Type   | Default | Required | Description         |\n| --------- | ------ | ------- | -------- | ------------------- |\n| `version` | String | latest  | false    | Neosync CLI version |\n\n## Publishing a new release\n\nThis project includes a helper script designed to streamline the process of\ntagging and pushing new releases for GitHub Actions.\n\nGitHub Actions allows users to select a specific version of the action to use,\nbased on release tags. Our script simplifies this process by performing the\nfollowing steps:\n\n1. **Retrieving the latest release tag:** The script starts by fetching the most\n   recent release tag by looking at the local data available in your repository.\n1. **Prompting for a new release tag:** The user is then prompted to enter a new\n   release tag. To assist with this, the script displays the latest release tag\n   and provides a regular expression to validate the format of the new tag.\n1. **Tagging the new release:** Once a valid new tag is entered, the script tags\n   the new release.\n1. **Pushing the new tag to the remote:** Finally, the script pushes the new tag\n   to the remote repository. From here, you will need to create a new release in\n   GitHub and users can easily reference the new tag in their workflows.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnucleuscloud%2Fsetup-neosync-cli-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnucleuscloud%2Fsetup-neosync-cli-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnucleuscloud%2Fsetup-neosync-cli-action/lists"}