{"id":21388051,"url":"https://github.com/envoy-vc/react-terminal","last_synced_at":"2025-03-16T12:40:15.035Z","repository":{"id":231242817,"uuid":"775125262","full_name":"Envoy-VC/react-terminal","owner":"Envoy-VC","description":"A highly customizable terminal component for your React applications.","archived":false,"fork":false,"pushed_at":"2024-09-18T01:55:44.000Z","size":7409,"stargazers_count":1,"open_issues_count":1,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-01-23T00:24:55.480Z","etag":null,"topics":["react","react-terminal","terminal","typescript"],"latest_commit_sha":null,"homepage":"https://terminal.envoy1084.xyz","language":"TypeScript","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/Envoy-VC.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":"CODE_OF_CONDUCT.md","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-03-20T20:05:38.000Z","updated_at":"2024-04-07T09:41:49.000Z","dependencies_parsed_at":"2025-01-23T00:33:31.913Z","dependency_job_id":null,"html_url":"https://github.com/Envoy-VC/react-terminal","commit_stats":null,"previous_names":["envoy-vc/react-terminal"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Envoy-VC%2Freact-terminal","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Envoy-VC%2Freact-terminal/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Envoy-VC%2Freact-terminal/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Envoy-VC%2Freact-terminal/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Envoy-VC","download_url":"https://codeload.github.com/Envoy-VC/react-terminal/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243870910,"owners_count":20361275,"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":["react","react-terminal","terminal","typescript"],"created_at":"2024-11-22T12:15:49.610Z","updated_at":"2025-03-16T12:40:15.014Z","avatar_url":"https://github.com/Envoy-VC.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp\u003e\n  \u003cpicture\u003e\n    \u003cimg alt=\"Lens SDK logo\" src=\"./assets/logo-full.svg\" width=\"100%\"\u003e\n  \u003c/picture\u003e\n\u003c/p\u003e\n\n**Introducing React Terminal: A customizable terminal component for your React applications.**\n\nHere's what it provides:\n\n- 🔮 **Highly Customizable**: Personalize the title bar, prompt, and output to perfectly match your app's design.\n- ⌨️ **Custom Commands**: Define your own commands to perform specific actions within your app.\n- ⏳ **Async/Await Support**: termireact handles asynchronous operations seamlessly, displaying a loader while waiting .\n- ⬆️ ⬇️ **Command History**: Navigate through past commands with ease using the up and down arrow keys.\n- #️⃣ **JSX Rendering**: Integrate JSX elements directly into your terminal output for a richer experience.\n- 🌈 **Ansi Support**: Support for ANSI escape codes to add color and style to your terminal output.\n- 🎨 **Multiple Themes**: Choose from pre-built themes or create your own custom look.\n- 📦 **Persistence (`IndexedDB`)**: Save and recall terminal history for a more convenient user experience.\n\n## Getting Started\n\nThe Project follows a Compound component pattern. You can use the components to build your own terminal. Each Components extends from Either a `div` or `textarea` (in case of input textarea) element so you can pass the element props to the components.\n\nInstall the package:\n\n```bash\nnpm install @envoy1084/react-terminal\n# or\nyarn add @envoy1084/react-terminal\n# or\npnpm add @envoy1084/react-terminal\n# or\nbun add @envoy1084/react-terminal\n```\n\nUsage:\n\n```tsx\nimport {\n\tTerminal,\n\tTerminalInputBox,\n\tTerminalLoader,\n\tTerminalOutput,\n\tTerminalTitleBar,\n\tTerminalWelcomeMessage,\n} from '@envoy1084/react-terminal';\n\nconst MyComponent = () =\u003e {\n\treturn (\n\t\t\u003cTerminal\u003e\n\t\t\t\u003cTerminalTitleBar\u003e\n\t\t\t\t\u003cTerminalTitleBar.ActionGroup /\u003e\n\t\t\t\t\u003cTerminalTitleBar.Title /\u003e\n\t\t\t\u003c/TerminalTitleBar\u003e\n\t\t\t\u003cTerminalWelcomeMessage /\u003e\n\t\t\t\u003cTerminalOutput /\u003e\n\t\t\t\u003cTerminalInputBox\u003e\n\t\t\t\t\u003cTerminalInputBox.Prompt /\u003e\n\t\t\t\t\u003cTerminalInputBox.TextArea /\u003e\n\t\t\t\u003c/TerminalInputBox\u003e\n\t\t\t\u003cTerminalLoader /\u003e\n\t\t\u003c/Terminal\u003e\n\t);\n};\n\nexport default MyComponent;\n```\n\n## Contributing\n\nIf you have any ideas on how to improve the project, feel free to contribute! Please read the [contributing guidelines](https://github.com/Envoy-VC/react-terminal/blob/main/CODE_OF_CONDUCT.md) before submitting a pull request.\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](https://github.com/Envoy-VC/react-terminal/blob/main/LICENSE.md)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fenvoy-vc%2Freact-terminal","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fenvoy-vc%2Freact-terminal","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fenvoy-vc%2Freact-terminal/lists"}