README
ts-add@1.0.0
Helps you to add packages with their corresponding types conveniently to your project.
Installation
ts-add
is available via NPM and recomended to install globally:
$ npm i -g ts-add@1.0.0
You can also use ts-add
via NPX without explicit installation:
$ npx ts-add ...
Synopsis
ts-add [-c completion] [-v version] [-h help]
ts-add [options]... package[@version] [[options] [package[@version]]]...
Options
| Alias, name | Type | Description |-----------------------------------|---------|- | -d, --dry-run | boolean | Run without installing any packages. | -D, --save-dev | boolean | Save regular (not @types) packages to devDependencies. | -P, --save-prod | boolean | Save @types packages to regular dependencies. | -t, --types-only | boolean | Install only @types packages. | -i, --ignore-package-json | boolean | Add "latest" tag for all installing packages in case of latest versions are required to install. | --ap, --allow-prerelease | boolean | Allow to install prerelease versions of @types packages. | -s, --silent | boolean | Hide output messages. | -r, --registry | string | Specify any other package registry besides https://registry.npmjs.org (can be stored in .npmrc). | -a, --_auth | string | Set Auth Basic token for custom registry (can be stored in .npmrc). | -l, --login | string | Set Auth Basic username for custom registry (can be stored in .npmrc). | -u, --username | string | The same as login, but cannot be stored in .npmrc. | -p, --password | string | Set Auth Basic password for custom registry (can be stored in .npmrc). | -c, --completion | boolean | Output bash CLI autocompletion alias and exit. | -v, --version | boolean | Output version information and exit. | -h, --help | boolean | Display this help and exit.
Examples
-d, --dry-run
Options
| Alias, name | Type | Description |-----------------------------------|---------|- | -d, --dry-run | boolean | Run without installing any packages. | -D, --save-dev | boolean | Save regular (not @types) packages to devDependencies. | -P, --save-prod | boolean | Save @types packages to regular dependencies. | -t, --types-only | boolean | Install only @types packages. | -i, --ignore-package-json | boolean | Add "latest" tag for all installing packages in case of latest versions are required to install. | --ap, --allow-prerelease | boolean | Allow to install prerelease versions of @types packages. | -s, --silent | boolean | Hide output messages. | -r, --registry | string | Specify any other package registry besides https://registry.npmjs.org (can be stored in .npmrc). | -a, --_auth | string | Set Auth Basic token for custom registry (can be stored in .npmrc). | -l, --login | string | Set Auth Basic username for custom registry (can be stored in .npmrc). | -u, --username | string | The same as login, but cannot be stored in .npmrc. | -p, --password | string | Set Auth Basic password for custom registry (can be stored in .npmrc). | -c, --completion | boolean | Output bash CLI autocompletion alias and exit. | -v, --version | boolean | Output version information and exit. | -h, --help | boolean | Display this help and exit.
Options
| Alias, name | Type | Description |-----------------------------------|---------|- | -d, --dry-run | boolean | Run without installing any packages. | -D, --save-dev | boolean | Save regular (not @types) packages to devDependencies. | -P, --save-prod | boolean | Save @types packages to regular dependencies. | -t, --types-only | boolean | Install only @types packages. | -i, --ignore-package-json | boolean | Add "latest" tag for all installing packages in case of latest versions are required to install. | --ap, --allow-prerelease | boolean | Allow to install prerelease versions of @types packages. | -s, --silent | boolean | Hide output messages. | -r, --registry | string | Specify any other package registry besides https://registry.npmjs.org (can be stored in .npmrc). | -a, --_auth | string | Set Auth Basic token for custom registry (can be stored in .npmrc). | -l, --login | string | Set Auth Basic username for custom registry (can be stored in .npmrc). | -u, --username | string | The same as login, but cannot be stored in .npmrc. | -p, --password | string | Set Auth Basic password for custom registry (can be stored in .npmrc). | -c, --completion | boolean | Output bash CLI autocompletion alias and exit. | -v, --version | boolean | Output version information and exit. | -h, --help | boolean | Display this help and exit.
Testing
Manually tested by developer. Automated tests are not provided.
Your improve suggestions and bug reports are welcome any time.