Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/notlmn/winreg-cli

Command line tool with a fluent API for modifying the Windows registry
https://github.com/notlmn/winreg-cli

Last synced: about 2 months ago
JSON representation

Command line tool with a fluent API for modifying the Windows registry

Awesome Lists containing this project

README

        

# winreg-cli

> Command line tool that provides a fluent API for modifying Windows registry

![npm](https://img.shields.io/npm/v/winreg-cli.svg)
![license](https://img.shields.io/github/license/notlmn/winreg-cli.svg)

```
C:\> winreg
winreg [command]

Commands:
winreg read Read a value from the registry [aliases: r]
winreg list List subkeys and values of a key [aliases: l]
winreg write Write a value to the registry [aliases: w]
winreg delete Delete a key/value from the registry [aliases: d]

Options:
--help Show help [boolean]
--version Show version number [boolean]
```

## Installation
```
$ npm install -g winreg-cli
```

## Commands

### `winreg read `
Reads the data of a single value item from the `path`

### `winreg list [--recursive|-r]`
Lists the contents of a registry `key`, including subkeys and values

### `winreg write --type --data `
Stores the given `data` at the specified `path` in the registry

### `winreg delete [--force|-f]`
Deletes a value item or key from the registry. (The `--force` flag is required to delete keys)

## Possible values

### ``
* `HKLM`
* `HKCU`
* `HKCR`
* `HKU`
* `HKCC`

### ``
* `none` => `'REG_NONE'`
* `string` => `'REG_SZ'`
* `mstring` => `'REG_MULTI_SZ'`
* `estring` => `'REG_EXPAND_SZ'`
* `dword` => `'REG_DWORD'`
* `qword` => `'REG_QWORD'`
* `binary` => `'REG_BINARY'`

## Known issues
* Cannot read default values
* Cannot write to default values
* Cannot clear a key, only delete the key/value
* Can only create values not empty keys

## License
[MIT](./LICENSE)