{"id":14965224,"url":"https://github.com/saltstack/pepper","last_synced_at":"2025-05-16T00:07:02.693Z","repository":{"id":7204541,"uuid":"8509557","full_name":"saltstack/pepper","owner":"saltstack","description":"A library and stand-alone CLI tools to access a salt-api instance","archived":false,"fork":false,"pushed_at":"2025-03-18T19:20:16.000Z","size":376,"stargazers_count":248,"open_issues_count":51,"forks_count":124,"subscribers_count":30,"default_branch":"develop","last_synced_at":"2025-04-08T11:11:11.079Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","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/saltstack.png","metadata":{"files":{"readme":"README.rst","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}},"created_at":"2013-03-01T20:21:48.000Z","updated_at":"2025-03-18T19:20:22.000Z","dependencies_parsed_at":"2025-04-01T09:41:45.223Z","dependency_job_id":null,"html_url":"https://github.com/saltstack/pepper","commit_stats":{"total_commits":292,"total_committers":40,"mean_commits":7.3,"dds":0.7191780821917808,"last_synced_commit":"8ab18e8fb81c275e19c1345146116cf14b9f1223"},"previous_names":[],"tags_count":23,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/saltstack%2Fpepper","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/saltstack%2Fpepper/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/saltstack%2Fpepper/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/saltstack%2Fpepper/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/saltstack","download_url":"https://codeload.github.com/saltstack/pepper/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254442854,"owners_count":22071878,"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-09-24T13:34:23.936Z","updated_at":"2025-05-16T00:06:57.662Z","avatar_url":"https://github.com/saltstack.png","language":"Python","readme":"======\nPepper\n======\n\n.. image:: https://img.shields.io/pypi/v/salt-pepper.svg\n   :target: https://pypi.org/project/salt-pepper\n.. image:: https://travis-ci.com/saltstack/pepper.svg?branch=develop\n   :target: https://travis-ci.com/saltstack/pepper\n.. image:: https://img.shields.io/pypi/pyversions/salt-pepper.svg\n   :target: https://pypi.org/project/salt-pepper\n.. image:: https://img.shields.io/badge/license-Apache2-blue.svg?maxAge=3600\n   :target: https://pypi.org/project/salt-pepper\n.. image:: https://codecov.io/gh/saltstack/pepper/branch/develop/graph/badge.svg\n   :target: https://codecov.io/gh/saltstack/pepper/branch/develop\n\nPepper contains a Python library and CLI scripts for accessing a remote\n`salt-api`__ instance.\n\n``pepperlib`` abstracts the HTTP calls to ``salt-api`` so existing Python\nprojects can easily integrate with a remote Salt installation just by\ninstantiating a class.\n\nThe ``pepper`` CLI script allows users to execute Salt commands from computers\nthat are external to computers running the ``salt-master`` or ``salt-minion``\ndaemons as though they were running Salt locally. The long-term goal is to add\nadditional CLI scripts maintain the same interface as Salt's own CLI scripts\n(``salt``, ``salt-run``, ``salt-key``, etc).\n\nIt does not require any additional dependencies and runs on Python 2.5+ and\nPython 3. (Python 3 support is new, please file an issue if you encounter\ntrouble.)\n\n.. __: https://github.com/saltstack/salt-api\n\nInstallation\n------------\n.. code-block:: bash\n\n    pip install salt-pepper\n\nUsage\n-----\n\nBasic usage is in heavy flux. You can run pepper using the script in %PYTHONHOME%/scripts/pepper (a pepper.cmd wrapper is provided for convenience to Windows users).\n\n.. code-block:: bash\n\n    export SALTAPI_USER=saltdev SALTAPI_PASS=saltdev SALTAPI_EAUTH=pam\n    pepper '*' test.ping\n    pepper '*' test.kwarg hello=dolly\n\nExamples leveraging the runner client.\n\n.. code-block:: bash\n\n    pepper --client runner reactor.list\n    pepper --client runner reactor.add event='test/provision/*' reactors='/srv/salt/state/reactor/test-provision.sls'\n\nConfiguration\n-------------\n\nYou can configure pepper through the command line, using environment variables\nor in a configuration file ``$HOME/.pepperrc`` with the following syntax :\n\n.. code-block::\n\n  [main]\n  SALTAPI_URL=https://localhost:8000/\n  SALTAPI_USER=saltdev\n  SALTAPI_PASS=saltdev\n  SALTAPI_EAUTH=pam\n\nContributing\n------------\n\nPlease feel free to get involved by sending pull requests or join us on the\nSalt mailing list or on IRC in #salt or #salt-devel.\n\nThis repo follows the same `contributing guidelines`__ as Salt and uses\nseparate develop and master branches for in-progress additions and bug-fix\nchanges respectively.\n\n.. __: https://docs.saltstack.com/en/latest/topics/development/contributing.html\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsaltstack%2Fpepper","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsaltstack%2Fpepper","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsaltstack%2Fpepper/lists"}