{"id":22058810,"url":"https://github.com/sd2e/aliases-cli","last_synced_at":"2025-03-23T16:46:07.892Z","repository":{"id":73350118,"uuid":"129550330","full_name":"SD2E/aliases-cli","owner":"SD2E","description":"A manager for App and Reactor aliases","archived":false,"fork":false,"pushed_at":"2018-06-20T05:35:21.000Z","size":34,"stargazers_count":1,"open_issues_count":1,"forks_count":0,"subscribers_count":8,"default_branch":"master","last_synced_at":"2025-01-28T22:51:18.606Z","etag":null,"topics":["agaveapi","cli","key-value","tacc","tacc-reactors-service"],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/SD2E.png","metadata":{"files":{"readme":"README.rst","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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-04-14T20:01:52.000Z","updated_at":"2023-02-16T01:40:36.000Z","dependencies_parsed_at":null,"dependency_job_id":"4233b32e-a23b-4fa5-bb24-7872a57ae9a9","html_url":"https://github.com/SD2E/aliases-cli","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SD2E%2Faliases-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SD2E%2Faliases-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SD2E%2Faliases-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SD2E%2Faliases-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SD2E","download_url":"https://codeload.github.com/SD2E/aliases-cli/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245136355,"owners_count":20566586,"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":["agaveapi","cli","key-value","tacc","tacc-reactors-service"],"created_at":"2024-11-30T17:25:16.651Z","updated_at":"2025-03-23T16:46:07.861Z","avatar_url":"https://github.com/SD2E.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"#####################\nSyd, an Alias Manager\n#####################\n\n.. image:: https://travis-ci.org/SD2E/aliases-cli.svg?branch=master\n    :target: https://travis-ci.org/SD2E/aliases-cli\n\n.. image:: https://img.shields.io/pypi/l/Django.svg\n    :target: https://raw.githubusercontent.com/SD2E/aliases-cli/master/LICENSE\n\nA CLI to manage Reactor and App alias mappings and permissions.\n\n**Features:**\n\n- Retrieve the current Reactor or App identifier for an alias\n- Add/update alias mappings to Reactor or App identifiers\n- Manage read/write access controls to aliases\n- List all aliases, even those shared with you\n- Retrieve the current Reactor or App identifier for an alias\n\nInstall\n=======\n\nIf you have not already, install and configure the SD2E _CLI. You should be\nable to run the CLI command ``metadata-list`` without error.\n\nInstall from GitHub checkout::\n\n    git clone https://github.com/SD2E/aliases-cli\n    cd aliases-cli\n    python setup.py install\n\n\nUsage\n=====\n\nThe name of the CLI tool is ``syd`` and its usage is relatively simple. An\nalias can have one and only one value at any given time. Aliases can be shared\nwith other users via setting their access control list (ACL). The common use\ncase is to make them visible to any authenticated user by granting the special\nuser ``world`` read-only access. This is how the SD2 administration team\ncreates aliases for use by the project at large.\n\nCommand and options::\n\n    syd - A manager for App and Reactor aliases\n\n    Usage:\n      syd ls [--sorted]\n      syd get \u003calias\u003e\n      syd add \u003calias\u003e \u003cid\u003e\n      syd rem \u003calias\u003e\n      syd acl \u003calias\u003e ([\u003cuser\u003e] [--read|--noread] [--write|--nowrite])\n      syd -h | --help\n      syd --version\n\n    Options:\n      -h --help                         Show this screen.\n      --version                         Show version.\n      --sorted                          Sort list results alphabetically\n\n    Examples:\n      $ syd add youve-got-mail EWPrqWNDqZ7p8\n      $ syd get youve-got-mail\n      EWPrqWNDqZ7p8\n      $ syd add youve-got-mail PrqWW8qZ7NDEp\n      $ syd get youve-got-mail\n      PrqWW8qZ7NDEp\n      $ syd acl youve-got-mail\n      vaughn - Read: True Write: True\n      $ syd acl youve-got-mail taco --read --write\n      taco - Read: True Write: False\n      $ syd acl youve-got-mail taco --noread\n      $ syd rem youve-got-mail\n\n    Having trouble?:\n      Get help from a person:\n      - support@sd2e.org\n      Report issues or contribute fixes\n      - https://github.com/SD2E/aliases-cli\n\nDeveloping\n==========\n\nInstall in development mode::\n\n    pip install -e .[test]\n\nRun tests::\n\n    # Basic - run tests against your current Python environment\n    python setup.py test\n\n    # Advanced - test in other Python environments with tox\n    tox\n\nContributing\n------------\n\nCheck out the ``develop`` branch and work from it. Create a ``fix`` or\n``feat`` branch and commit your changes (including at least minimal test\ncoverage) and push that branch to GitHub. Check the TravisCI results and\nissue a PR against once the tests pass. Changes will be merged into ``master``\nby the project maintainer(s).\n\n.. _CLI: https://sd2e.github.io/api-user-guide/docs/install_cli.html\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsd2e%2Faliases-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsd2e%2Faliases-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsd2e%2Faliases-cli/lists"}