{"id":30743380,"url":"https://github.com/aces/cbrain-cli","last_synced_at":"2025-09-04T02:07:01.987Z","repository":{"id":306729856,"uuid":"983710791","full_name":"aces/cbrain-cli","owner":"aces","description":"A command-line interface to the CBRAIN service","archived":false,"fork":false,"pushed_at":"2025-09-02T12:56:37.000Z","size":124,"stargazers_count":1,"open_issues_count":5,"forks_count":2,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-09-02T14:46:28.128Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","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/aces.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":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-05-14T19:49:21.000Z","updated_at":"2025-09-02T12:56:42.000Z","dependencies_parsed_at":"2025-07-27T09:23:39.133Z","dependency_job_id":"3677927f-2132-417e-884a-a1fe0ad37798","html_url":"https://github.com/aces/cbrain-cli","commit_stats":null,"previous_names":["aces/cbrain-cli"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/aces/cbrain-cli","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aces%2Fcbrain-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aces%2Fcbrain-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aces%2Fcbrain-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aces%2Fcbrain-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aces","download_url":"https://codeload.github.com/aces/cbrain-cli/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aces%2Fcbrain-cli/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":273539317,"owners_count":25123499,"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-09-04T02:00:08.968Z","response_time":61,"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":"2025-09-04T02:07:01.118Z","updated_at":"2025-09-04T02:07:01.973Z","avatar_url":"https://github.com/aces.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# CBRAIN CLI\n\nA command-line interface to a CBRAIN service\n============================================\n\nThis repository contains a UNIX command-line interface (CLI) for [CBRAIN](https://github.com/aces/cbrain).\n\nThe interface is implemented in Python using only standard libraries - no external dependencies required.\n\nThe main command is called \"cbrain\" and as is typical for such clients, works\nwith a set of subcommand and options (e.g. \"cbrain file list -j\") such as:\n```bash\ncbrain file list\ncbrain project show\ncbrain --json dataprovider list\n```\n\n## CBRAIN Access Options\n\nThere are two main ways to access CBRAIN:\n\n1. **McGill Production Portal** (Recommended for Regular Users)\n   - Access the McGill-supported CBRAIN production portal at: https://portal.cbrain.mcgill.ca/\n   - No local installation required\n   - Web-based interface for most common operations\n\n2. **Custom/Development Setup**\n   - Deploy CBRAIN on your lab cluster, cloud, or virtual machine\n   - Suitable for organizations wanting their own CBRAIN instance\n   - Local installation only needed for:\n     - CLI software developers\n     - Power users developing/debugging custom CLI scripts\n   - Follow setup instructions at [CBRAIN GitHub Repository](https://github.com/aces/cbrain) if you need a local instance\n\n## Installation\n\nThis CLI tool uses pure Python with no external library dependencies, making installation straightforward.\n\n### Option 1: Direct Usage\n\n1. Clone this repository:\n   ```bash\n   git clone https://github.com/aces/cbrain-cli.git\n   cd cbrain-cli\n   ```\n\n2. Run directly:\n   ```bash\n   ./cbrain --help # Make the cbrain script executable by `chmod +x cbrain`\n   ```\n\n### Option 2: Virtual Environment\n\nFor isolated usage:\n\n```bash\n# Create and activate virtual environment\npython3 -m venv venv\nsource venv/bin/activate  # On Windows: venv\\Scripts\\activate\npip install -e .\n```\n\n### Initial Setup\n\nAfter installation, you need to login to your CBRAIN instance:\n\n```bash\ncbrain login\n```\n\nWhen prompted for \"Enter CBRAIN server URL prefix\", enter:\n- For McGill Production Portal: `https://portal.cbrain.mcgill.ca`\n- For custom setup: Your CBRAIN instance URL\n\n## API Reference\n\nThis CLI interfaces with the CBRAIN REST API. For complete API documentation and specifications, refer to:\n- [CBRAIN API Documentation (Swagger)](https://app.swaggerhub.com/apis/prioux/CBRAIN/7.0.0)\n\n## Development\n\nThis is part of a GSoC (Google Summer of Code) project sponsored by [INCF](https://www.incf.org/).\n\nThe lead developer is [axif0](https://github.com/axif0), mentored by the developers of the CBRAIN project.\n\n## License\n\nSee [LICENSE](LICENSE) file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faces%2Fcbrain-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faces%2Fcbrain-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faces%2Fcbrain-cli/lists"}