{"id":23327893,"url":"https://github.com/kui-shell/oui","last_synced_at":"2025-08-30T09:34:28.681Z","repository":{"id":36249058,"uuid":"221455118","full_name":"kui-shell/oui","owner":"kui-shell","description":"Visual Terminal for OpenWhisk","archived":false,"fork":false,"pushed_at":"2022-12-30T19:05:57.000Z","size":3446,"stargazers_count":11,"open_issues_count":35,"forks_count":2,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-12-11T23:16:48.454Z","etag":null,"topics":["cli","electron","kui","openwhisk","tool","visualization"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/kui-shell.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}},"created_at":"2019-11-13T12:32:42.000Z","updated_at":"2022-08-22T19:41:58.000Z","dependencies_parsed_at":"2023-01-17T00:00:36.871Z","dependency_job_id":null,"html_url":"https://github.com/kui-shell/oui","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kui-shell%2Foui","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kui-shell%2Foui/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kui-shell%2Foui/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kui-shell%2Foui/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kui-shell","download_url":"https://codeload.github.com/kui-shell/oui/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":230645357,"owners_count":18258530,"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":["cli","electron","kui","openwhisk","tool","visualization"],"created_at":"2024-12-20T20:53:45.680Z","updated_at":"2024-12-20T20:53:46.146Z","avatar_url":"https://github.com/kui-shell.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# A Visual Terminal for OpenWhisk\n\n[![Build Status](https://travis-ci.org/kui-shell/oui.svg?branch=master)](https://travis-ci.org/kui-shell/oui)\n[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)\n\nThis project offers a platform-native client that offers graphical\npopups in response to normal OpenWhisk commands. To provide a\npopup-from-terminal experience, this project leverages the\n[Kui](https://github.com/IBM/kui) project.\n\nFor example, `oui action list` will pop up a window that displays a\ntable with clickable pod names; the screenshot to the right\nillustrates one such popup. \u003cimg alt=\"oui popup\"\nsrc=\"docs/action-list.png\" width=\"500px\" align=\"right\"/\u003e\n\nUpon clicking a resource name in a table, you will be presented with a\nmulti-tab view of the detail of the resource you selected; the\nscreenshot a bit further down and on the left illustrates such a\n[multi-tab detail view](docs/oui-flow.png) for an OpenWhisk sequence.\n\n# Code and Contribute\n\n```bash\ngit clone https://github.com/kui-shell/oui \u0026\u0026 cd oui\nnpm ci\nnpm start\n```\n\nYou should see a window come up. You can now try, for example, `wsk action list`, and expect to see a table (assuming you have deployed\nactions), with clickable cells, in response.\n\n\u003cimg alt=\"oui sequence detail\" src=\"docs/oui-flow.png\" width=\"400px\" align=\"left\"/\u003e\n\n## Edit-debug Loop\n\nThis project is coded in [TypeScript](https://www.typescriptlang.org).\nYou may launch a TypeScript watcher via:\n\n```\nnpm run watch\n```\n\nThe edit-debug loop involves: edit and save a source change; wait for\nthe TypeScript compiler to recompile your source changes; finally, in\nmost cases a simple reload (via Ctrl+R, or Command+R on macOS) of the\ndevelopment client suffices to integrate your changes into an\nalready-open window.\n\n## Building a Distribution\n\nTo pack up a set of platform clients for subsequent distribution, you\nmay leverage several npm targets expressed in the\n[package.json](package.json):\n\nThis command will build a macOS tarball, and place it in\n`dist/electron/Oui-darwin-x64.tar.bz2`:\n\n```sh\nnpm run build:electron:mac\n```\n\n# Theming\n\nYou have the option to customize the theming in several ways. Here are\nsome of the choices you can influence:\n\n- client name\n- client icon\n- default theme\n- available themes\n\nThese changes are captured in the `theme/` subdirectory. More details\ncoming soon. For now, browse the [theme.json](theme/theme.json) file.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkui-shell%2Foui","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkui-shell%2Foui","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkui-shell%2Foui/lists"}