tsrpc-cli/README.md

TSRPC CLI Tools

TSRPC CLI Tools
===

EN / [中文](README_CN.md)

CLI utilities for [TSRPC](https://npmjs.com/tsrpc) 

# Install
```
npm i -g tsrpc-cli
```

## Usage
### Development Utilities
```
tsrpc proto <options>                Generate proto file
    --config <file>                     Read params from config file (would ignore all other CLI params)
    -i, --input <file>                  Input TS file (support glob expression)
                                        It would generate all exported types
    -o, --output <file>                 Output file (or print to CLI)
    -c, --compatible <file>             Compatible mode, compatible to old proto (=output by default)
    --new                               Generate fresh new proto (no compatible)
    --ugly                              Output as ugly JSON (no indent and smaller)
    --verbose                           Show debug info
    --ignore <glob>                     Files to be ignored from --input

tsrpc api <options>                  Generate TSRPC API implementations
    --config <file>                     Read params from config file (would ignore all other CLI params)
    -i, --input <file>                  Proto file path (proto.ts or proto.json)
    -o, --output <folder>               Output api folder path

tsrpc sync                           Sync directory content as readonly
    --config <file>                     Read params from config file (would ignore all other CLI params)
    --from <dir>                        Source path
    --to <dir>                          Target path (copy and set as read-only)

tsrpc link <options>                 Create symlink (cross all operating system)
    --config <file>                     Read params from config file (would ignore all other CLI params)
    --from <dir>                        Source path
    --to <dir>                          Target path for created symlink

tsrpc dev <options>                  Run local dev server
    --config <file>                     Read params from config file (would ignore all other CLI params)

tsrpc build <options>                Build the server project
    --config <file>                     Read params from config file (would ignore all other CLI params)
```

### Buffer Utilities

```
tsrpc encode <options> [exp]         Encode a JS expression or a file (content is JS expression)
    [exp]                               Expression to encode (e.g. "123" "new Uint8Array([1,2,3])")
    -p, --proto <file>                  Proto file to use
    -s, --schema <id>                   SchemaID (filePath/TypeName)
    -i, --input <file>                  Input file path, alternative to [exp]
    -o, --output <file>                 Output file path (or print to CLI)
    --verbose                           Show debug info
                                        
tsrpc decode <options> [binstr]      Decode buffer
    [binstr]                            Buffer to decode, hex string, like "0F A2 E3"
    -p, --proto <file>                  Proto file
    -s, --schema <id>                   SchemaID (filePath/TypeName)
    -i, --input <file>                  Input file path, alternative to [binstr]
    -o, --output <file>                 Output file path (or print to CLI)
    --verbose                           Show debug info

tsrpc validate <options> [exp]       Validate if a JS expression is valid to a schema
    [exp]                               Expression to validate (e.g. "123" "new Uint8Array([1,2,3])")
    -p, --proto <file>                  Proto file to use
    -s, --schema <id>                   SchemaID (filePath/TypeName)
    -i, --input <file>                  Input file path, alternative to [exp]

tsrpc show <file>                    Show a binary file as hex string
```

## Examples

### Use Config File
```
tsrpc proto --config tsrpc.config.ts
tsrpc api   --config tsrpc.config.ts
tsrpc sync  --config tsrpc.config.ts
tsrpc link  --config tsrpc.config.ts
tsrpc dev   --config tsrpc.config.ts
tsrpc build --config tsrpc.config.ts
```

### Generate Proto
```
tsrpc proto -i shared/protocols -o shared/protocols/proto.ts
```

### Encode Test
```
tsrpc encode -p proto.json -s a/b/c/TypeName "{value: 1}"
tsrpc encode -p proto.ts -s a/b/c/TypeName "{value: 1}" -o buf.bin 
```

### Decode Test
```
tsrpc decode -p proto.json -s a/b/c/TypeName "01 0A 01"
tsrpc decode -p proto.json -s a/b/c/TypeName -i buf.bin
```

### Validation Test
```
tsrpc validate -p proto.json -s a/b/c/TypeName "{value: 1}"
tsrpc validate -p proto.json -s a/b/c/TypeName -i value.js
```

### Show Buffer Content
```
tsrpc show buf.bin
```