{"id":16905118,"url":"https://github.com/hyperbrain/serverless-vscode","last_synced_at":"2025-03-23T17:30:40.996Z","repository":{"id":78212353,"uuid":"115342465","full_name":"HyperBrain/serverless-vscode","owner":"HyperBrain","description":"Serverless framework integration for VSCode","archived":false,"fork":false,"pushed_at":"2018-04-07T11:33:58.000Z","size":147,"stargazers_count":28,"open_issues_count":8,"forks_count":3,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-18T22:09:49.173Z","etag":null,"topics":["serverless","serverless-framework","vscode","vscode-extension"],"latest_commit_sha":null,"homepage":null,"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/HyperBrain.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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}},"created_at":"2017-12-25T14:09:28.000Z","updated_at":"2023-11-06T04:46:27.000Z","dependencies_parsed_at":"2023-04-09T01:36:43.716Z","dependency_job_id":null,"html_url":"https://github.com/HyperBrain/serverless-vscode","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HyperBrain%2Fserverless-vscode","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HyperBrain%2Fserverless-vscode/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HyperBrain%2Fserverless-vscode/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HyperBrain%2Fserverless-vscode/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/HyperBrain","download_url":"https://codeload.github.com/HyperBrain/serverless-vscode/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245140686,"owners_count":20567427,"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":["serverless","serverless-framework","vscode","vscode-extension"],"created_at":"2024-10-13T18:37:14.085Z","updated_at":"2025-03-23T17:30:40.987Z","avatar_url":"https://github.com/HyperBrain.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"## Serverless Framework integration for VS Code\n\n[![Version](https://vsmarketplacebadge.apphb.com/version/frankschmid.serverless-vscode.svg)](https://marketplace.visualstudio.com/items?itemName=frankschmid.serverless-vscode)\n[![Installs](https://vsmarketplacebadge.apphb.com/installs/frankschmid.serverless-vscode.svg)](https://marketplace.visualstudio.com/items?itemName=frankschmid.serverless-vscode)\n[![Ratings](https://vsmarketplacebadge.apphb.com/rating/frankschmid.serverless-vscode.svg)](https://marketplace.visualstudio.com/items?itemName=frankschmid.serverless-vscode)\n\nThis extension enables an integration of Serverless projects with VSCode. It eliminates the need\nto start Serverless commands from a separate command line.\n\n## Installation\n\nIn order to install an extension you need to open the extension palette and search for serverless-vscode.\nYou can then install it.\n\n**Currently the extension only supports Serverless projects with Serverless installed locally!**\n\nThat means, that Serverless must be a development dependency of the project itself. A subsequent\nversion of the extension will also support the globally installed Serverless framework and a\nconfiguration for that.\n\n## Configuration\n\nThe extension supports user and workspace configuration. To access the configuration settings,\nopen `File-\u003ePreferences-\u003eSettings` (workspace or user) and expand the `Serverless Configuration` node.\n\nThe following configuration settings are available:\n\n### serverless.aws.askForRegion\n\nWhen set to false (the default), the extension will not ask for the region to deploy to but use the\none, set as `serverless.aws.defaultRegion`. This reduces the typing needed to execute a single\ncommand, as normally you'll not deploy cross-region that often.\n\n### serverless.aws.defaultStage\n\nThe defult stage that is assumed, if you just press ENTER in the stage input field when executing a command.\n\n### serverless.aws.defaultRegion\n\nThe defult region that is assumed, if you just press ENTER in the stage input field when executing a command. See also `serverless.aws.askForRegion`.\n\n## Usage\n\n### The Serverless outline\n\nAs soon as you have added a Serverless project to your workspace, you can select the `serverless.yml`\nin the Explorer tree view. Then an outline is shown in the Explorer view, that shows the parsed\nstructure of your Serverless service definition.\nThe outline will contain a `functions` and an `API` hive, which contain the defined functions in the\nproject and the defined API endpoint hierarchy. Each item in the outline has a context menu that allows\naccess to context specific commands. Most of the command will ask you for the target stage when triggered.\n\n#### Top container objects\n\nEach of the top hives has a context menu that lets you invoke service/project related functions.\n\n![Function](images/service-demo.png \"Service\")\n\n##### Package\n\nPackage will ask for the stage and optionally region and packages the service with `serverless package`.\n\n##### Deploy\n\nPackage will ask for the stage and optionally region and deploys the service with `serverless deploy`.\n\n##### Variable resolution (Resolve)\n\nResolve allows you to show a generated `resolved.yml`, i.e. your `serverless.yml` with all Serverless\nvariables resolved to their values for a selected stage.\n\n#### Functions\n\nThe functions hive lets you analyze your service function-wise and contains a node for each function.\nEach function then contains a list of all defined HTTP endpoints in the function definition.\n\n![Function](images/function-demo.png \"Function\")\n\nAll function related commands of the extension can be called via the context menu of the function.\n\n![FunctionContext](images/function-context.png \"Function context menu\")\n\n##### Deploy function\n\nDeploys the selected function with `serverless deploy function`. Attention: In general, single function\ndeployment does not replace a service deployment. See the Serverless documentation for details.\n\n##### Invoke local\n\nInvoke the selected function locally. The command lets you select an `event.json` that will be used\nfor the local invocation. Setting a custom context is not yet possible.\n\n##### Show logs\n\nRetrieve and show the online logs of the deployed function in the output pane.\n\n##### Open handler\n\nOpen the handler source file that is associated with the function.\n\n#### API\n\nThe API hive shows the combined API that will eventually be deployed to API Gateway.\n\n## Releases\n\nSee the `CHANGELOG.MD` file.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhyperbrain%2Fserverless-vscode","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhyperbrain%2Fserverless-vscode","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhyperbrain%2Fserverless-vscode/lists"}