{"id":19888273,"url":"https://github.com/project-codeflare/codeflare-cli","last_synced_at":"2025-05-02T17:31:58.192Z","repository":{"id":36985337,"uuid":"497008047","full_name":"project-codeflare/codeflare-cli","owner":"project-codeflare","description":null,"archived":false,"fork":false,"pushed_at":"2023-10-11T16:39:24.000Z","size":7866,"stargazers_count":12,"open_issues_count":25,"forks_count":12,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-05-07T18:28:46.526Z","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":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/project-codeflare.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":"2022-05-27T13:30:26.000Z","updated_at":"2023-10-25T21:31:07.000Z","dependencies_parsed_at":"2023-01-17T12:16:04.063Z","dependency_job_id":null,"html_url":"https://github.com/project-codeflare/codeflare-cli","commit_stats":null,"previous_names":[],"tags_count":204,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/project-codeflare%2Fcodeflare-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/project-codeflare%2Fcodeflare-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/project-codeflare%2Fcodeflare-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/project-codeflare%2Fcodeflare-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/project-codeflare","download_url":"https://codeload.github.com/project-codeflare/codeflare-cli/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224324498,"owners_count":17292521,"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-12T18:06:48.028Z","updated_at":"2024-11-12T18:06:48.111Z","avatar_url":"https://github.com/project-codeflare.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![CLI Tests](https://github.com/project-codeflare/codeflare-cli/actions/workflows/cli.yml/badge.svg)](https://github.com/project-codeflare/codeflare-cli/actions/workflows/cli.yml)\n[![UI Tests](https://github.com/project-codeflare/codeflare-cli/actions/workflows/ui.yml/badge.svg)](https://github.com/project-codeflare/codeflare-cli/actions/workflows/ui.yml)\n[![Kube Tests](https://github.com/project-codeflare/codeflare-cli/actions/workflows/kind.yml/badge.svg)](https://github.com/project-codeflare/codeflare-cli/actions/workflows/kind.yml)\n[![Self-test Tests](https://github.com/project-codeflare/codeflare-cli/actions/workflows/self-test.yml/badge.svg)](https://github.com/project-codeflare/codeflare-cli/actions/workflows/self-test.yml)\n\n# The CodeFlare CLI\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"./images/codeflare_cli.svg\" width=\"110\" height=\"110\" align=\"left\"\u003e\n\u003c/p\u003e\n\n[CodeFlare](https://codeflare.dev) simplifies the integration, scaling\nand acceleration of complex multi-step analytics and machine learning\npipelines on the cloud.\n\nThis repository houses the CodeFlare CLI, `codeflare`, which helps\nyou to submit and observe jobs in a Kubernetes cluster.\n\n[Check out some use cases in motion](./docs/scenarios/README.md#readme).\n\n\u003ca href=\"https://asciinema.org/a/518021\" target=\"_blank\"\u003e\u003cimg src=\"https://asciinema.org/a/518021.svg\" height=\"175\"/\u003e\u003c/a\u003e\n\u003ca href=\"https://asciinema.org/a/517989\" target=\"_blank\"\u003e\u003cimg src=\"https://asciinema.org/a/517989.svg\" height=\"175\"/\u003e\u003c/a\u003e\n\u003ca href=\"https://asciinema.org/a/517993\" target=\"_blank\"\u003e\u003cimg src=\"https://asciinema.org/a/517993.svg\" height=\"175\"/\u003e\u003c/a\u003e\n\n## How `codeflare` Works\n\nThe `codeflare` CLI is programmed with a set of tasks. Each task knows\nhow to **guide** you through the complexities of running against a\nremote cluster. For example, `codeflare` tasks include submitting a\nRay job to a Kubernetes cluster, or observing such a running job.\n\nThe way `codeflare` guides you is by asking you questions. It tries\nto formulate each question as a choice from a list of\npossibilities. In this example, it attempts to list your available\nKubernetes clusters, and you need only select from that list. It does\nthe same kind of thing for S3 data (e.g. showing you a list of\navailable S3 buckets). Some questions require more free-form\nresponses. For example, when asking for the resource requirements of\nyour job, it presents a form that you can edit to specify how many\nGPUs you need.\n\n### Managing Profiles\n\nThe `codeflare` CLI remembers your answers to these questions in a\n**profile**. This allows you to easily re-run a task using the same\nanswers as before: `codeflare -y/--yes`, which auto-accepts your prior\nanswers, as long as those answers are still valid. To run with a\nprofile name of your choosing, use the `-p/--profile` command line\noption. In doing so, you may thus quickly switch between variants,\ne.g. different input data, or different Kubernetes clusters.\n\nTo manage your profiles, use the `codeflare profile\n\u003clist|get|delete|clone\u003e` command lines.\n\n## Installation\n\nVisit the\n[Releases](https://github.com/project-codeflare/codeflare-cli/releases/latest)\npage. Download the package for your platform, unpack it, and place the\nenclosed `bin/` directory on your `PATH`. macOS users may use\n[HomeBrew](https://brew.sh/):\n\n    brew tap project-codeflare/codeflare-cli https://github.com/project-codeflare/codeflare-cli\n    brew install codeflare\n\n## Contributing\n\nWant to help out? Check out the [developer guide](./docs/development/README.md).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fproject-codeflare%2Fcodeflare-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fproject-codeflare%2Fcodeflare-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fproject-codeflare%2Fcodeflare-cli/lists"}