{"id":14988418,"url":"https://github.com/apache/openwhisk-vscode-extension","last_synced_at":"2025-10-19T13:31:26.858Z","repository":{"id":42239527,"uuid":"328885239","full_name":"apache/openwhisk-vscode-extension","owner":"apache","description":"VSCode extension for Apache OpenWhisk","archived":false,"fork":false,"pushed_at":"2024-01-19T06:10:34.000Z","size":1000,"stargazers_count":11,"open_issues_count":12,"forks_count":8,"subscribers_count":28,"default_branch":"master","last_synced_at":"2024-10-01T01:22:10.358Z","etag":null,"topics":["apache","cloud","dev-tools","faas","functions-as-a-service","openwhisk","serverless","serverless-architectures","serverless-functions","vscode-extension"],"latest_commit_sha":null,"homepage":"https://openwhisk.apache.org/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/apache.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2021-01-12T05:47:14.000Z","updated_at":"2023-09-08T18:17:06.000Z","dependencies_parsed_at":"2024-01-23T17:32:17.083Z","dependency_job_id":null,"html_url":"https://github.com/apache/openwhisk-vscode-extension","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apache%2Fopenwhisk-vscode-extension","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apache%2Fopenwhisk-vscode-extension/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apache%2Fopenwhisk-vscode-extension/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apache%2Fopenwhisk-vscode-extension/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/apache","download_url":"https://codeload.github.com/apache/openwhisk-vscode-extension/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":219869247,"owners_count":16555572,"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":["apache","cloud","dev-tools","faas","functions-as-a-service","openwhisk","serverless","serverless-architectures","serverless-functions","vscode-extension"],"created_at":"2024-09-24T14:16:40.793Z","updated_at":"2025-10-19T13:31:26.318Z","avatar_url":"https://github.com/apache.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003c!--\n#\n# Licensed to the Apache Software Foundation (ASF) under one or more\n# contributor license agreements.  See the NOTICE file distributed with\n# this work for additional information regarding copyright ownership.\n# The ASF licenses this file to You under the Apache License, Version 2.0\n# (the \"License\"); you may not use this file except in compliance with\n# the License.  You may obtain a copy of the License at\n#\n#     http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n#\n--\u003e\n\n# OpenWhisk VS Code Extension\n\nAn **openwhisk-vscode-extension** is an open-source VS Code extension for [Apache OpenWhisk](https://openwhisk.apache.org/). It manages the wskdeploy manifest file and makes deployment easy. You can also create and update actions and packages in VS Code.\n\nTry creating and editing your action code in the VS Code!\n\n## Prerequisites\n\nInstall the dependencies below to use full features:\n\n- [vscode](https://code.visualstudio.com/) \u003e= 1.41.0\n- [wskdeploy](https://github.com/apache/openwhisk-wskdeploy/releases)\n\nThis extension finds the `.wskprops` configuration file located in the home path and connects to the Openwhisk server automatically. Set up your configuration referred to the [cli docs](https://github.com/apache/openwhisk/blob/master/docs/cli.md#openwhisk-cli).\n\n## Features\n\n### OpenWhisk Explorer\n\n- Explore all entities in your endpoints/namespaces.\n    - The .wskprops file is automatically registered.\n    - You can add the API host manually.\n    - You can add the namespace manually by API auth key.\n- Show the action code with syntax highlighting.\n- Edit the action code on the remote server.\n- Invoke the action remotely and get the activation result.\n- Show a list of actions related to the sequence action.\n- Show information about the trigger and related rules.\n- Show activations related to the action (Same as `wsk activation list \u003caction\u003e`).\n- Show detailed information of the activation (Same as `wsk activation get \u003cactivation_id\u003e`).\n- Update parameters and annotations of the action, package, and trigger.\n\n### Manifest View (in the workspace explorer)\n\n- List up manifest YAML files in the workspace.\n- Deploy/Undeploy OpenWhisk packages with manifest (via wskdeploy).\n    - Deploy with the deployment file.\n    - Deploy with multiple credentials.\n\n## Commands\nThis extension contributes the following commands to the Command palette.\n\n- `Create a wskdeploy project`: creates a wskdeploy project\n\n## How to debug in your local environment\n\n### Requirements\n\n- [vscode](https://code.visualstudio.com/) \u003e= 1.41.0\n- [Node.js](https://nodejs.org/en/download/) \u003e= 12.x\n- Have an OpenWhisk deployment available, which you set up by following this [guide](https://openwhisk.apache.org/documentation.html#pre-requisites) or by using one of the managed OpenWhisk offerings (e.g., from IBM, Adobe or Nimbella). Note, deployments with self signed SSL certificates may not work with this extension.\n\n### Set up\n\n1. Clone the repository:\n\n    ```bash\n    git clone https://github.com/apache/openwhisk-vscode-extension.git\n    code ./openwhisk-vscode-extension # Open openwhisk-vscode-extension in VS Code\n    ```\n\n2. In your terminal, execute the command `npm install` to install extension dependencies\n3. In your terminal, execute the command `npm run webpack-dev` to start up the extension builder in watch mode (allows for making changes to files and rebuilding automatically)\n4. Open up the `src/extension.ts` file for editing\n5. In the `src/extension.ts` file press `F5` button to start debugger and select `VS Code Extension Development` if a modal appears at the top of the VS Code window\n6. Interact with the `DEBUG CONSOLE` for real time debugging of the extension and learn more about debugging [here](https://github.com/apache/openwhisk-vscode-extension/blob/master/vsc-extension-quickstart.md)\n\n## License\n\n```\nLicensed to the Apache Software Foundation (ASF) under one or more\ncontributor license agreements.  See the NOTICE file distributed with\nthis work for additional information regarding copyright ownership.\nThe ASF licenses this file to You under the Apache License, Version 2.0\n(the \"License\"); you may not use this file except in compliance with\nthe License.  You may obtain a copy of the License at\n\n   http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n```\n\n## Third-party Product Acknowledgement\n\nPortions of this product include SVG files developed by the XEIcon project (https://github.com/xpressengine/XEIcon).\n\n - Dark theme: https://github.com/apache/openwhisk-vscode-extension/tree/master/resource/dark\n - Light theme: https://github.com/apache/openwhisk-vscode-extension/tree/master/resource/light\n\nThose files are distributed under the XEIcon license (https://github.com/xpressengine/XEIcon#license).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapache%2Fopenwhisk-vscode-extension","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fapache%2Fopenwhisk-vscode-extension","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapache%2Fopenwhisk-vscode-extension/lists"}