https://github.com/rhdeck/serverless-setup
Utility for setting up serverless config
https://github.com/rhdeck/serverless-setup
Last synced: 11 months ago
JSON representation
Utility for setting up serverless config
- Host: GitHub
- URL: https://github.com/rhdeck/serverless-setup
- Owner: rhdeck
- License: mit
- Created: 2018-11-07T16:36:19.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2020-10-07T18:40:22.000Z (over 5 years ago)
- Last Synced: 2025-06-17T03:05:02.779Z (about 1 year ago)
- Language: TypeScript
- Size: 38.1 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Usage
```bash
serverless-setup [options]
```
# Options
* -p --currentPath \<`pathname`> Reference path for examining a serverlesss setup (default: .
* -t --stage \<`stage`> Stack stage to check against. Defaul value is dev (default: dev
* -a --aws-profile \<`profile`> Named AWS Profile
* -f --file-name [filename] File to write output (default config.json) (default: config.json
* -s --standard-output Write to standard output instead of config.json
* -n --stack-name \<`stackname`> Name of the stack/application (e.g. privilege, test-a, etc)
* -r --region \<`region`> Region to pass to serverless commands
# @raydeck/serverless-setup - v3.1.0
## Index
### Variables
* [cachedAccountId](#let-cachedaccountid)
### Functions
* [getAccountID](#const-getaccountid)
* [makeConfig](#const-makeconfig)
* [writeConfig](#const-writeconfig)
## Variables
### `Let` cachedAccountId
• **cachedAccountId**: *string | undefined*
*Defined in [index.ts:8](https://github.com/rhdeck/serverless-setup/blob/8da9d7d/src/index.ts#L8)*
## Functions
### `Const` getAccountID
▸ **getAccountID**(): *Promise‹string›*
*Defined in [index.ts:9](https://github.com/rhdeck/serverless-setup/blob/8da9d7d/src/index.ts#L9)*
**Returns:** *Promise‹string›*
___
### `Const` makeConfig
▸ **makeConfig**(`__namedParameters`: object): *Promise‹object›*
*Defined in [index.ts:16](https://github.com/rhdeck/serverless-setup/blob/8da9d7d/src/index.ts#L16)*
**Parameters:**
▪ **__namedParameters**: *object*
Name | Type | Default |
------ | ------ | ------ |
`awsProfile` | undefined | string | - |
`cmd` | cmd | - |
`currentPath` | string | process.cwd() |
`fromName` | string | - |
`getMyResources` | boolean | false |
`ignoreResources` | boolean | false |
`region` | undefined | string | - |
`stage` | string | "dev" |
**Returns:** *Promise‹object›*
___
### `Const` writeConfig
▸ **writeConfig**(`fromObject`: object, `toPath`: string, `fileName`: string): *boolean*
*Defined in [index.ts:109](https://github.com/rhdeck/serverless-setup/blob/8da9d7d/src/index.ts#L109)*
**Parameters:**
Name | Type | Default |
------ | ------ | ------ |
`fromObject` | object | - |
`toPath` | string | process.cwd() |
`fileName` | string | "config.json" |
**Returns:** *boolean*