{"id":38535571,"url":"https://github.com/itsfarseen/shellspec","last_synced_at":"2026-01-17T07:01:06.247Z","repository":{"id":314225241,"uuid":"1053412527","full_name":"itsfarseen/shellspec","owner":"itsfarseen","description":"Testing framework for shell commands with declarative syntax.","archived":false,"fork":false,"pushed_at":"2025-09-14T10:02:32.000Z","size":794,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-10-11T14:34:45.305Z","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":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/itsfarseen.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-09-09T12:16:28.000Z","updated_at":"2025-09-14T10:02:35.000Z","dependencies_parsed_at":"2025-09-13T23:01:20.498Z","dependency_job_id":null,"html_url":"https://github.com/itsfarseen/shellspec","commit_stats":null,"previous_names":["itsfarseen/shellspec"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/itsfarseen/shellspec","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/itsfarseen%2Fshellspec","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/itsfarseen%2Fshellspec/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/itsfarseen%2Fshellspec/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/itsfarseen%2Fshellspec/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/itsfarseen","download_url":"https://codeload.github.com/itsfarseen/shellspec/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/itsfarseen%2Fshellspec/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28503021,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-17T06:57:29.758Z","status":"ssl_error","status_checked_at":"2026-01-17T06:56:03.931Z","response_time":85,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":"2026-01-17T07:00:57.058Z","updated_at":"2026-01-17T07:01:06.205Z","avatar_url":"https://github.com/itsfarseen.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![CI Tests](https://github.com/itsfarseen/shellspec/actions/workflows/ci.yml/badge.svg)](https://github.com/itsfarseen/shellspec/actions/workflows/ci.yml)\n\n# ShellSpec\n\nTesting framework for shell commands with declarative syntax.\n\n## Features\n\n- Test shell commands with expected success/failure\n- Interactive command testing with pexpect\n- Variable storage and manipulation\n- File operations and content verification\n- Reusable test snippets\n- Isolated test environments\n\n## Installation\n\nRequirements: Python 3.7+, pexpect library\n\n```bash\npip install pexpect\nchmod +x shellspec.py\n```\n\n## Usage\n\n```bash\n# Run all tests\n./shellspec.py mytests.spec\n\n# Run specific test by number or name\n./shellspec.py mytests.spec --test 1\n./shellspec.py mytests.spec --test \"file operations\"\n\n# Show command output\n./shellspec.py mytests.spec --verbose\n```\n\n## Writing Tests\n\nFor complete syntax documentation, see [SYNTAX.md](SYNTAX.md).\n\nFor a quick reference, see the [cheatsheet](shellspec-cheatsheet.txt).\n\n### Basic Test Structure\n\n```\n\u003e Test case name\n$. command args           # Run command expecting success\n?. stdout \"expected\"      # Assert stdout contains \"expected\"\n```\n\n## Demos and Examples\n\n**Calculator**\n\nSee the [calculator_spec.txt](examples/calculator_spec.txt) for the test implementation.\n\n![Calculator Demo](screencasts/calculator.gif)\n\n\n**File Processor**\n\nSee the [file_processor_spec.txt](examples/file_processor_spec.txt) for the test implementation.\n\n![File Processor Demo](screencasts/file_processor.gif)\n\n**Interactive Calculator**\n\nSee the [interactive_calculator_spec.txt](examples/interactive_calculator_spec.txt) for the test implementation.\n\n![Interactive Calculator Demo](screencasts/interactive_calculator.gif)\n\n\n## Configuration\n\n### Command Aliases\n\nShellSpec allows you to define aliases for commands to simplify testing or provide custom paths. Edit the `COMMAND_ALIASES` dictionary in `shellspec.py`:\n\n```python\nCOMMAND_ALIASES = {\n    \"myapp\": \"../path/to/myapp\",\n    \"python3\": \"/usr/bin/python3\",\n}\n```\n\nCommands not found in the aliases dictionary will be executed directly as system commands.\n\n### Timeout Settings\n\nThe default timeout for shell commands is 30 seconds. Modify `SHELL_TIMEOUT` in `shellspec.py` to change this.\n\n## Documentation\n\n- **[SYNTAX.md](SYNTAX.md)** - Complete syntax reference with examples\n- **[shellspec-cheatsheet.txt](shellspec-cheatsheet.txt)** - Quick reference for all commands\n\n\n## License\n\nMIT License - see [LICENSE](LICENSE) for details.\n\n## Related Projects\n\nShellSpec was originally developed as part of the age-store project for testing command-line encryption tools. It has been extracted into its own project for broader use.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fitsfarseen%2Fshellspec","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fitsfarseen%2Fshellspec","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fitsfarseen%2Fshellspec/lists"}