API Reference
Command
New-ImageQRCodeShadowSocks
Generates a QR code for a Shadowsocks configuration.
Remarks
Use this cmdlet to share a client-ready Shadowsocks connection string as a scannable QR code.
Examples
Create a basic Shadowsocks QR code
PS>
New-ImageQRCodeShadowSocks -Host 'example.com' -Port 8388 -Password 'pwd' -Method Aes256Gcm -FilePath ss.png
Creates a QR code for importing a Shadowsocks connection into a compatible client.
Create a tagged Shadowsocks client profile QR code
PS>
New-ImageQRCodeShadowSocks -Host 'vpn.evotec.pl' -Port 8388 -Password 'StrongSecret!' -Method Chacha20IetfPoly1305 -Tag 'Warsaw Edge' -FilePath ss-warsaw.png -ForegroundColor Purple -PixelSize 14 -Show
Generates a named client profile QR code and opens it immediately after creation.
Common Parameters
This command supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.
For more information, see about_CommonParameters.
Syntax
New-ImageQRCodeShadowSocks [-BackgroundColor <Color>] -FilePath <String> [-ForegroundColor <Color>] -Method <Chacha20IetfPoly1305> -Password <String> [-PixelSize <Int32>] -Port <Int32> -ServerHost <String> [-Show] [-Tag <String>] [<CommonParameters>]#Parameter set:
All Parameter SetsParameters
- BackgroundColor Color
- Background color of the QR code.
- FilePath String
- The image format is inferred from the file extension.
- ForegroundColor Color
- Foreground color of QR modules.
- Method QrShadowSocksMethod
- Encryption method.
- Possible values:
Chacha20IetfPoly1305,Aes128Gcm,Aes192Gcm,Aes256Gcm,XChacha20IetfPoly1305,Aes128Cfb,Aes192Cfb,Aes256Cfb,Aes128Ctr,Aes192Ctr,Aes256Ctr,Camellia128Cfb,Camellia192Cfb,Camellia256Cfb,Chacha20Ietf,Aes256Cb,Aes128Ofb,Aes192Ofb,Aes256Ofb,Aes128Cfb1,Aes192Cfb1,Aes256Cfb1,Aes128Cfb8,Aes192Cfb8,Aes256Cfb8,Chacha20,BfCfb,Rc4Md5,Salsa20,DesCfb,IdeaCfb,Rc2Cfb,Cast5Cfb,Salsa20Ctr,Rc4,SeedCfb,Table - Password String
- Password for the server.
- PixelSize Int32
- Pixel size for each QR module.
- Port Int32
- Server port.
- ServerHost String
- Server host name.
- Show SwitchParameter
- Opens the image after creation.
- Tag String
- Optional tag.