{"id":20027708,"url":"https://github.com/cragglesg/cshell","last_synced_at":"2026-05-12T18:05:24.752Z","repository":{"id":261296714,"uuid":"850373996","full_name":"CragglesG/cshell","owner":"CragglesG","description":"A brand-new shell made in Python.","archived":false,"fork":false,"pushed_at":"2024-11-17T13:32:08.000Z","size":36,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-01-12T17:25:32.747Z","etag":null,"topics":["high-seas","python3","shell"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/CragglesG.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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":"2024-08-31T15:40:22.000Z","updated_at":"2024-11-17T13:32:11.000Z","dependencies_parsed_at":"2024-11-05T19:51:33.814Z","dependency_job_id":"09a0697c-3c87-43ff-b04b-2f5901f46467","html_url":"https://github.com/CragglesG/cshell","commit_stats":null,"previous_names":["cragglesg/cshell"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CragglesG%2Fcshell","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CragglesG%2Fcshell/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CragglesG%2Fcshell/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CragglesG%2Fcshell/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/CragglesG","download_url":"https://codeload.github.com/CragglesG/cshell/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241460045,"owners_count":19966516,"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":["high-seas","python3","shell"],"created_at":"2024-11-13T09:11:27.853Z","updated_at":"2026-05-12T18:05:24.746Z","avatar_url":"https://github.com/CragglesG.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# CShell\nCShell is an extensible, POSIX-compliant shell made with Python.\n\n_Found a bug? Want a new feature? [Create an issue!](https://github.com/CragglesG/cshell/issues/new) (Please check for an existing one first to avoid duplicates.)_\n\n_Want to contribute? You can find good first issues [here](https://github.com/CragglesG/cshell/contribute)._\n\n## Table of Contents\n\n- [Installation Guide](#installation-guide)\n- [Features](#features)\n- [`ShellExtension` and the CShell Extension Framework](#shellextension-and-the-cshell-extension-framework)\n\n## Installation Guide\n\nCShell ony supports Linux at this time. Support for macOS and Windows may come soon.\n\nTo install CShell, execute this command:\n\n```sh\ngit clone https://github.com/CragglesG/cshell cshell-install \u0026\u0026 cd cshell-install \u0026\u0026 ./install.sh\n```\n\nThe above command clones the CShell repo, enters the cloned directory, and runs the install script. To update your user `PATH`, run:\n\n```\nsource ~/.bashrc\n```\n\nYou can now run CShell with the `cshell` command.\n\n## Features\n\nHere's a list of features that are available in CShell:\n\n- `exit`, `echo`, `type`, `pwd`, `cd`, `builtins`, `reload`, and `history` built-ins\n- History and `.inputrc` support\n- Extensions framework through `ShellExtension`\n- Environment variables support\n- Built-in `PATH` support\n- Fallback to default system shell\n\n## `ShellExtension` and the CShell Extension Framework\n\nThe CShell Extension Framework allows developers to extend CShell using the `ShellExtension` class. Extensions are provided with the user input, path files, and built-ins available in the current session, along with a function to display output to the user. Below is an example of a simple CShell extension:\n\n```python\nfrom shell_extensions import ShellExtension\n\nclass TestExtension(ShellExtension):\n    def __init__(self):\n        super().__init__(\"test-extension\", self.test)\n    \n    def test(self, msg, pathfiles, builtins, send):\n        send(\"This is a test extension\\n\")\n```\n\nThe above extension displays the output `This is a test extension` to the user, followed by a newline. The newline is necessary to move the prompt to the next line. The `super().__init__` function takes two arguments, the extension command and the function to call.\n\nAll extensions should be located in `~/.cshell/extensions/`. CShell will scan this folder for extensions and register them upon starting.\n\n\u003e **Important:**\n\u003e CShell first searches for commands in the built-ins dictionary, followed by the extensions dictionary, and finally the path files dictionary. Extensions can therefore override path files, but not built-ins.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcragglesg%2Fcshell","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcragglesg%2Fcshell","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcragglesg%2Fcshell/lists"}