stream-chat-net-cli

The Stream Chat CLI (Command Line Interface)

Requirements

.NET Core 5.0

Clone

git clone https://github.com/rostislav-nikitin/stream-chat-net-cli.git

cd stream-chat-net-cli/src

Build

Set app settings with your custom API_KEY / API_SECRET

Scenario 1. Replace API_KEY / API_SECRET in the appsettings.json or appsettings.Development.json

Use this scenario if you will NOT commit your changes. Otherwise the appsettings.json width you sensitive data will be commited into the repo.

{
	"ConnectionStrings":
	{
		"StreamChat": "API_KEY, API_SECRET"
	}
}

Scenario 2. Use secret manager

Use this scenario if you will commit your changes into the public repository. In this case SreamChat API_KEY / API_SECRET will be NOT commited into the repo. For this init your user secrets and add the ConnectionStrings:StreamChat key:

make set-connection-string "API_KEY, API_SECRET"

Build & Test

make build test

Currently supported commands

Help

./schat-cli --help

User token

• User token create

./schat-cli userToken create
	--user={UserId}
	[--debug]

Example:

./schat-cli userToken create --user=TestUser

Result:

eyJ0eTAiOiJKV1QfLCJhbGc6OiJIUz11NiJ9.eyt1c2VyX2lkIjoiU29tZVVzZXIifQ.gg2Lhd6fsvAtmimuDRQ14tq6iH5cYYm3F7K1sZS4P3w

User

• User create

./schat-cli user create \
	[--id={UserId}] \
	[--role={Admin|Anonymous|Any|AnyAuthenticated|ChannelMember|ChannelModerator|Guest|User(default)}] \
	[--name='{FullName}'] \
	[--debug]

Example:

./schat-cli user create --id=TestUser --role=User --name='Test User'

Result:

ID:		 TestUser
Role:		 user
Online:		 False
Last active:	 
Deactivated at: 
Deactivated at: 
Created at:	 1/5/2021 2:32:47 PM
Updated at:	 1/5/2021 2:32:47 PM
Name:		 Test User

• User list

./schat-cli user list 
	[--limit={Limit(Default=100,Max=100)}]
	[--offset={Offset(Default=0)}]
	[--debug]

Example:

1	ID: 1eccb4f7-ccf7-4e1e-b2eb-64a51557defc  	 Role: user	 Online: False	 Last Active: 
2	ID: 24c3b87d-e471-460a-8d9a-bb10ec4b3730  	 Role: admin	 Online: False	 Last Active: 
3	ID: 3d8ad1fe-d580-42ff-8fa6-88f548e69c1a  	 Role: user	 Online: False	 Last Active:
...

• User update

./schat-cli user update \
	--id={UserId} \
	[--role={Admin|Anonymous|Any|AnyAuthenticated|ChannelMember|ChannelModerator|Guest|User(default)}] \
	[--name='{FullName}'] \
	[--debug]

Example:

./schat-cli user update --id=TestUser --role=User --name='Test User'

Result:

ID:		 TestUser
Role:		 user
Online:		 False
Last active:	 
Deactivated at: 
Deactivated at: 
Created at:	 1/5/2021 2:32:47 PM
Updated at:	 1/5/2021 2:32:47 PM
Name:		 Test User

Channel type

• Channel type create

./schat-cli channelType create \
	 [--name={ChannelTypeName}] \
	 [--automod={AI|Disabled(default)|Simple}] \
	 [--mutes={True|False}] \
	 [--connectEvents={True|False}] \
	 [--maxMessageLength={MaxMessageLength}] \
	 [--messageRetention={MessageRetention}] \
	 [--reactions={True|False}] \
	 [--readEvents={True|False}] \
	 [--replies={True|False}] \
	 [--search={True|False}] \
	 [--typingEvents={True|False}] \
	 [--commands='{Command1 Command2 ... CommandN}'] \
	 [--debug]

Example:

./schat-cli channelType create --name=TestChannel \
 	--automod=ai --mutes=True --typingEvents=True

Result:

Created at:		 1/5/2021 1:18:33 PM
Udpated at:		 1/5/2021 1:18:33 PM
Name:			 TestChannel
Typing events:		 True
Read events:		 False
Connect events:		 False
Search:			 1/5/2021 1:18:33 PM
Reactions:		 False
Replies:		 False
Mutes:			 True
Message retention:	 infinite
Max message length:	 5000
Automod:		 disabled

• Channel type get

./schat-cli channelType get 
	 --name={ChannelTypeName}
	 [--debug]

Example:

./schat-cli channelType get --name=messaging

Result:

Created at:		 1/5/2021 1:18:33 PM
Udpated at:		 1/5/2021 1:18:33 PM
Name:			 messaging
Typing events:		 True
Read events:		 True
Connect events:		 True
Search:			 1/5/2021 1:18:33 PM
Reactions:		 True
Replies:		 True
Mutes:			 True
Message retention:	 infinite
Max message length:	 5000
Automod:		 disabled

• Channel type list

./schat-cli channelType list
	[--debug]

Example:

./schat-cli channelType list

Result:

somestream
messaging

• Channel type delete

./schat-cli channelType delete
	--name={ChannelTypeName}
	[--debug]

Example:

./schat-cli channelType delete --name=TestChannel

Channel

• Channel create

./schat-cli channel create \
	[--id={ChannelID}] \
	--type={ChannelType} \
	--creator={UserId} \
	[--users='{UserId1 UserId2...UserIdN}']
	[--debug]

Example:

./schat-cli channel create --id=TestChannel --type=TestChannelType --creator=TestUser --users='TestUser AnotherTestUser'

Result:

ID:			 TestChannel
Type:			 TestChannelType
CID:			 TestChannelType:TestChannel
Created By:		 TestUser
Created At:		 1/12/2021 12:11:00 AM
Updated At:		 1/12/2021 12:11:00 AM
Deleted At:		 
Last Message At:	 
Frozen:			 False
Member Count:		 2

• Channel list

./schat-cli channel list
	[--limit={Limit(Default=100,Max=100)}]
	[--offset={Offset(Default=0)}]
	[--debug]

Example:

./schat-cli channel list

Result:

1        CID: TestChannelType:TestChannel	 Frozen: False	 Member Count: 2	 Created By: TestUser	 Created At: 1/11/2021 11:30:56 PM
2	 CID: 93ecdad8:b9458a72	                 Frozen: False	 Member Count: 1	 Created By: 64a51557	 Created At: 1/11/2021 11:29:15 PM
...

Channel Message

• Channel message list

./schat-cli channelMessage list
	--channelId={ChannelId}
	[--limit={Limit(Default=100,Max=100)}]
	[--offset={Offset(Default=0)}]
	[--debug]

Example:

./schat-cli channelMessage list --channelId='TestChannel'

Result:

ID: 32a94395-227a-4a57-9f3a-6a44f236db32   Type: regular   User ID: TestUser1   Created at: 2020/12/22 10:56:26  Reply count: 1   Text: Hi there
ID: fd4f7eaa-75e1-4e76-b4d1-eb821633255c   Type: regular   User ID: TestUser2   Created at: 2020/12/30 06:59:24  Reply count: 0   Text: Glad to see you
ID: 2f7f9afc-f79b-4b36-8e18-9108f80c24e1   Type: regular   User ID: TestUser1   Created at: 2021/01/04 09:18:42  Reply count: 0   Text: Bye

• Channel message send

./schat-cli channelMessage send
	--channelId={ChannelId}
	--userId={UserId}
	--message='{Message text}'
	[--debug]

Example:

./schat-cli channelMessage send --channelId=TestChannel --userId=TestUser --message='Hi there!'

Result:

ID:              a0b1033b-db0f-48e9-8f41-ad9bac68ca52
Type:            regular   
User ID:         TestUser
Created at:      2021/01/22 22:31:25
Reply count:     0  
Text:            Hi there!

• Channel message reply

./schat-cli channelMessage reply
	--channelId={ChannelId}
	--userId={UserId}
	--messageId={MessageId}
	--message='{Message text}'
	[--debug]

Example:

./schat-cli channelMessage reply --channelId=TestChannel --userId=AnotherTestUser --messageId='a0b1033b-db0f-48e9-8f41-ad9bac68ca52' --message='I am fine, thank you.'

Result:

ID:              b0b10726-32a7-1191-bc00-3ef0d56baa8b
Type:            reply     
User ID:         AnotherTestUser
Created at:      2021/01/25 21:10:26
Reply count:     0  
Text:            I am fine, thank you.

Message

• Message delete

./schat-cli message delete
	--id={MessageId}
	[--debug]

Example:

./schat-cli message delete --id=TestMessage