Mokhtar Naamani 497f3380c5 cli README | 2 years ago | |
---|---|---|
.. | ||
bin | 4 years ago | |
examples | 2 years ago | |
scripts | 2 years ago | |
src | 2 years ago | |
test | 4 years ago | |
.eslintignore | 3 years ago | |
.eslintrc.js | 4 years ago | |
.gitignore | 3 years ago | |
.prettierignore | 3 years ago | |
README.md | 2 years ago | |
codegen.yml | 3 years ago | |
package.json | 2 years ago | |
tsconfig.json | 3 years ago |
Command Line Interface for Joystream community and governance activities
$ npm install -g @joystream/cli
$ joystream-cli COMMAND
running command...
$ joystream-cli (-v|--version|version)
@joystream/cli/0.7.0 darwin-x64 node-v14.16.1
$ joystream-cli --help [COMMAND]
USAGE
$ joystream-cli COMMAND
...
To run a command in developemnt environment (from the root of Joystream monorepo, without installing the package):
$ yarn && yarn workspace @joystream/types build && yarn workspace @joystream/metadata-protobuf build
$ ./cli/bin/run COMMAND # OR:
$ yarn joystream-cli COMMAND
Alternatively:
$ yarn workspace @joystream/cli link
$ joystream-cli COMMAND
When using the CLI for the first time there are a few common steps you might want to take in order to configure the CLI:
api:setUri
and choosing one of the suggested endpoints of providing your own url. To verify the currently used Joystream node websocket endpoint you can execute api:getUri
.content:createChannel
) will require a connection to the query node in order to fetch the data they need complete the requested operations (ie. content:createChannel
will need to fetch the available storage node endnpoints in order to upload the channel assets). In order to do that, execute api:setQueryNodeEndpoint
and choose one of the suggested endpoints or provide your own url. You can use api:getQueryNodeEndpoint
any time to verify the currently set endpoint.account:import
command. You can provide json backup files exported from Pioneer or Polkadot{.js} extension as an input. You can also use raw mnemonic or seed phrases. See the account:import
command documentation for the full list of supported inputs.
The key to sign the transaction(s) with will be determined based on the required permissions, depending on the command you execute. For example, if you execute working-groups:updateRewardAccount --group storageProviders
, the CLI will look for a storage provider role key among your available keys. If multiple execution contexts are available, the CLI will prompt you to choose the desired one.[Tab]
while typing the command name in the console. Executing autocomplete
command will provide you the instructions on how to set this up.--help
flag to investigate the available commands or take a look at the commands documentation below.
FORCE_COLOR=0
- disables output coloring. This will make the output easier to parse in case it's redirected to a file or used within a script.AUTO_CONFIRM=true
- this will make the CLI skip asking for any confirmations (can be useful when creating bash scripts).
joystream-cli account:create
joystream-cli account:export DESTPATH
joystream-cli account:forget
joystream-cli account:import
joystream-cli account:info [ADDRESS]
joystream-cli account:list
joystream-cli account:transferTokens
joystream-cli api:getQueryNodeEndpoint
joystream-cli api:getUri
joystream-cli api:inspect
joystream-cli api:setQueryNodeEndpoint [ENDPOINT]
joystream-cli api:setUri [URI]
joystream-cli autocomplete [SHELL]
joystream-cli content:addCuratorToGroup [GROUPID] [CURATORID]
joystream-cli content:channel CHANNELID
joystream-cli content:channels
joystream-cli content:createChannel
joystream-cli content:createChannelCategory
joystream-cli content:createCuratorGroup
joystream-cli content:createVideo
joystream-cli content:createVideoCategory
joystream-cli content:curatorGroup ID
joystream-cli content:curatorGroups
joystream-cli content:deleteChannel
joystream-cli content:deleteChannelCategory CHANNELCATEGORYID
joystream-cli content:deleteVideo
joystream-cli content:deleteVideoCategory VIDEOCATEGORYID
joystream-cli content:removeChannelAssets
joystream-cli content:removeCuratorFromGroup [GROUPID] [CURATORID]
joystream-cli content:reuploadAssets
joystream-cli content:setCuratorGroupStatus [ID] [STATUS]
joystream-cli content:setFeaturedVideos FEATUREDVIDEOIDS
joystream-cli content:updateChannel CHANNELID
joystream-cli content:updateChannelCategory CHANNELCATEGORYID
joystream-cli content:updateChannelCensorshipStatus ID [STATUS]
joystream-cli content:updateChannelModerators
joystream-cli content:updateVideo VIDEOID
joystream-cli content:updateVideoCategory VIDEOCATEGORYID
joystream-cli content:updateVideoCensorshipStatus ID [STATUS]
joystream-cli content:video VIDEOID
joystream-cli content:videos [CHANNELID]
joystream-cli forum:addPost
joystream-cli forum:categories
joystream-cli forum:category
joystream-cli forum:createCategory
joystream-cli forum:createThread
joystream-cli forum:deleteCategory
joystream-cli forum:moderatePost
joystream-cli forum:moderateThread
joystream-cli forum:moveThread
joystream-cli forum:posts
joystream-cli forum:setStickiedThreads
joystream-cli forum:threads
joystream-cli forum:updateCategoryArchivalStatus
joystream-cli forum:updateCategoryModeratorStatus
joystream-cli help [COMMAND]
joystream-cli membership:addStakingAccount
joystream-cli membership:buy
joystream-cli membership:details
joystream-cli membership:update
joystream-cli membership:updateAccounts
joystream-cli staking:validate
joystream-cli working-groups:application WGAPPLICATIONID
joystream-cli working-groups:apply
joystream-cli working-groups:cancelOpening OPENINGID
joystream-cli working-groups:createOpening
joystream-cli working-groups:decreaseWorkerStake WORKERID AMOUNT
joystream-cli working-groups:evictWorker WORKERID
joystream-cli working-groups:fillOpening
joystream-cli working-groups:increaseStake AMOUNT
joystream-cli working-groups:leaveRole
joystream-cli working-groups:opening
joystream-cli working-groups:openings
joystream-cli working-groups:overview
joystream-cli working-groups:removeUpcomingOpening
joystream-cli working-groups:setDefaultGroup
joystream-cli working-groups:slashWorker WORKERID AMOUNT
joystream-cli working-groups:updateGroupMetadata
joystream-cli working-groups:updateRewardAccount [ADDRESS]
joystream-cli working-groups:updateRoleAccount [ADDRESS]
joystream-cli working-groups:updateRoleStorage STORAGE
joystream-cli working-groups:updateWorkerReward WORKERID NEWREWARD
joystream-cli account:create
Create a new account
USAGE
$ joystream-cli account:create
OPTIONS
--name=name Account name
--type=(sr25519|ed25519) Account type (defaults to sr25519)
See code: src/commands/account/create.ts
joystream-cli account:export DESTPATH
Export account(s) to given location
USAGE
$ joystream-cli account:export DESTPATH
ARGUMENTS
DESTPATH Path where the exported files should be placed
OPTIONS
-a, --all If provided, exports all existing accounts into "exported_accounts" folder inside given path
-n, --name=name Name of the account to export
See code: src/commands/account/export.ts
joystream-cli account:forget
Forget (remove) account from the list of available accounts
USAGE
$ joystream-cli account:forget
OPTIONS
--address=address Address of the account to remove
--name=name Name of the account to remove
See code: src/commands/account/forget.ts
joystream-cli account:import
Import account using mnemonic phrase, seed, suri or json backup file
USAGE
$ joystream-cli account:import
OPTIONS
--backupFilePath=backupFilePath Path to account backup JSON file
--mnemonic=mnemonic Mnemonic phrase
--name=name Account name
--password=password Account password
--seed=seed Secret seed
--suri=suri Substrate uri
--type=(sr25519|ed25519) Account type (defaults to sr25519)
See code: src/commands/account/import.ts
joystream-cli account:info [ADDRESS]
Display detailed information about specified account
USAGE
$ joystream-cli account:info [ADDRESS]
ARGUMENTS
ADDRESS An address to inspect (can also be provided interavtively)
ALIASES
$ joystream-cli account:inspect
See code: src/commands/account/info.ts
joystream-cli account:list
List all available accounts
USAGE
$ joystream-cli account:list
See code: src/commands/account/list.ts
joystream-cli account:transferTokens
Transfer tokens from any of the available accounts
USAGE
$ joystream-cli account:transferTokens
OPTIONS
--amount=amount (required) Amount of tokens to transfer
--from=from Address of the sender (can also be provided interactively)
--to=to Address of the recipient (can also be provided interactively)
See code: src/commands/account/transferTokens.ts
joystream-cli api:getQueryNodeEndpoint
Get current query node endpoint
USAGE
$ joystream-cli api:getQueryNodeEndpoint
See code: src/commands/api/getQueryNodeEndpoint.ts
joystream-cli api:getUri
Get current api WS provider uri
USAGE
$ joystream-cli api:getUri
See code: src/commands/api/getUri.ts
joystream-cli api:inspect
Lists available node API modules/methods and/or their description(s), or calls one of the API methods (depending on provided arguments and flags)
USAGE
$ joystream-cli api:inspect
OPTIONS
-M, --module=module
Specifies the api module, ie. "system", "staking" etc.
If no "--method" flag is provided then all methods in that module will be listed along with the descriptions.
-a, --callArgs=callArgs
Specifies the arguments to use when calling a method. Multiple arguments can be separated with a comma, ie.
"-a=arg1,arg2".
You can omit this flag even if the method requires some aguments.
In that case you will be promted to provide value for each required argument.
Ommiting this flag is recommended when input parameters are of more complex types (and it's hard to specify them as
just simple comma-separated strings)
-e, --exec
Provide this flag if you want to execute the actual call, instead of displaying the method description (which is
default)
-m, --method=method
Specifies the api method to call/describe.
-t, --type=type
Specifies the type/category of the inspected request (ie. "query", "consts" etc.).
If no "--module" flag is provided then all available modules in that type will be listed.
If this flag is not provided then all available types will be listed.
EXAMPLES
$ api:inspect
$ api:inspect -t=query
$ api:inspect -t=query -M=members
$ api:inspect -t=query -M=members -m=membershipById
$ api:inspect -t=query -M=members -m=membershipById -e
$ api:inspect -t=query -M=members -m=membershipById -e -a=1
See code: src/commands/api/inspect.ts
joystream-cli api:setQueryNodeEndpoint [ENDPOINT]
Set query node endpoint
USAGE
$ joystream-cli api:setQueryNodeEndpoint [ENDPOINT]
ARGUMENTS
ENDPOINT Query node endpoint for the CLI to use
See code: src/commands/api/setQueryNodeEndpoint.ts
joystream-cli api:setUri [URI]
Set api WS provider uri
USAGE
$ joystream-cli api:setUri [URI]
ARGUMENTS
URI Uri of the node api WS provider (if skipped, a prompt will be displayed)
See code: src/commands/api/setUri.ts
joystream-cli autocomplete [SHELL]
display autocomplete installation instructions
USAGE
$ joystream-cli autocomplete [SHELL]
ARGUMENTS
SHELL shell type
OPTIONS
-r, --refresh-cache Refresh cache (ignores displaying instructions)
EXAMPLES
$ joystream-cli autocomplete
$ joystream-cli autocomplete bash
$ joystream-cli autocomplete zsh
$ joystream-cli autocomplete --refresh-cache
See code: @oclif/plugin-autocomplete
joystream-cli content:addCuratorToGroup [GROUPID] [CURATORID]
Add Curator to existing Curator Group.
USAGE
$ joystream-cli content:addCuratorToGroup [GROUPID] [CURATORID]
ARGUMENTS
GROUPID ID of the Curator Group
CURATORID ID of the curator
OPTIONS
--useMemberId=useMemberId Try using the specified member id as context whenever possible
--useWorkerId=useWorkerId Try using the specified worker id as context whenever possible
See code: src/commands/content/addCuratorToGroup.ts
joystream-cli content:channel CHANNELID
Show Channel details by id.
USAGE
$ joystream-cli content:channel CHANNELID
ARGUMENTS
CHANNELID Name or ID of the Channel
OPTIONS
--useMemberId=useMemberId Try using the specified member id as context whenever possible
--useWorkerId=useWorkerId Try using the specified worker id as context whenever possible
See code: src/commands/content/channel.ts
joystream-cli content:channels
List existing content directory channels.
USAGE
$ joystream-cli content:channels
OPTIONS
--useMemberId=useMemberId Try using the specified member id as context whenever possible
--useWorkerId=useWorkerId Try using the specified worker id as context whenever possible
See code: src/commands/content/channels.ts
joystream-cli content:createChannel
Create channel inside content directory.
USAGE
$ joystream-cli content:createChannel
OPTIONS
-i, --input=input (required) Path to JSON file to use as input
--context=(Member|Curator) Actor context to execute the command in (Member/Curator)
--useMemberId=useMemberId Try using the specified member id as context whenever possible
--useWorkerId=useWorkerId Try using the specified worker id as context whenever possible
See code: src/commands/content/createChannel.ts
joystream-cli content:createChannelCategory
Create channel category inside content directory.
USAGE
$ joystream-cli content:createChannelCategory
OPTIONS
-i, --input=input (required) Path to JSON file to use as input
--context=(Lead|Curator) Actor context to execute the command in (Lead/Curator)
--useMemberId=useMemberId Try using the specified member id as context whenever possible
--useWorkerId=useWorkerId Try using the specified worker id as context whenever possible
See code: src/commands/content/createChannelCategory.ts
joystream-cli content:createCuratorGroup
Create new Curator Group.
USAGE
$ joystream-cli content:createCuratorGroup
OPTIONS
--useMemberId=useMemberId Try using the specified member id as context whenever possible
--useWorkerId=useWorkerId Try using the specified worker id as context whenever possible
ALIASES
$ joystream-cli createCuratorGroup
See code: src/commands/content/createCuratorGroup.ts
joystream-cli content:createVideo
Create video under specific channel inside content directory.
USAGE
$ joystream-cli content:createVideo
OPTIONS
-c, --channelId=channelId (required) ID of the Channel
-i, --input=input (required) Path to JSON file to use as input
--context=(Owner|Collaborator) Actor context to execute the command in (Owner/Collaborator)
--useMemberId=useMemberId Try using the specified member id as context whenever possible
--useWorkerId=useWorkerId Try using the specified worker id as context whenever possible
See code: src/commands/content/createVideo.ts
joystream-cli content:createVideoCategory
Create video category inside content directory.
USAGE
$ joystream-cli content:createVideoCategory
OPTIONS
-i, --input=input (required) Path to JSON file to use as input
--context=(Lead|Curator) Actor context to execute the command in (Lead/Curator)
--useMemberId=useMemberId Try using the specified member id as context whenever possible
--useWorkerId=useWorkerId Try using the specified worker id as context whenever possible
See code: src/commands/content/createVideoCategory.ts
joystream-cli content:curatorGroup ID
Show Curator Group details by ID.
USAGE
$ joystream-cli content:curatorGroup ID
ARGUMENTS
ID ID of the Curator Group
OPTIONS
--useMemberId=useMemberId Try using the specified member id as context whenever possible
--useWorkerId=useWorkerId Try using the specified worker id as context whenever possible
See code: src/commands/content/curatorGroup.ts
joystream-cli content:curatorGroups
List existing Curator Groups.
USAGE
$ joystream-cli content:curatorGroups
OPTIONS
--useMemberId=useMemberId Try using the specified member id as context whenever possible
--useWorkerId=useWorkerId Try using the specified worker id as context whenever possible
See code: src/commands/content/curatorGroups.ts
joystream-cli content:deleteChannel
Delete the channel and optionally all associated data objects.
USAGE
$ joystream-cli content:deleteChannel
OPTIONS
-c, --channelId=channelId (required) ID of the Channel
-f, --force Force-remove all associated channel data objects
--useMemberId=useMemberId Try using the specified member id as context whenever possible
--useWorkerId=useWorkerId Try using the specified worker id as context whenever possible
See code: src/commands/content/deleteChannel.ts
joystream-cli content:deleteChannelCategory CHANNELCATEGORYID
Delete channel category.
USAGE
$ joystream-cli content:deleteChannelCategory CHANNELCATEGORYID
ARGUMENTS
CHANNELCATEGORYID ID of the Channel Category
OPTIONS
--context=(Lead|Curator) Actor context to execute the command in (Lead/Curator)
--useMemberId=useMemberId Try using the specified member id as context whenever possible
--useWorkerId=useWorkerId Try using the specified worker id as context whenever possible
See code: src/commands/content/deleteChannelCategory.ts
joystream-cli content:deleteVideo
Delete the video and optionally all associated data objects.
USAGE
$ joystream-cli content:deleteVideo
OPTIONS
-f, --force Force-remove all associated video data objects
-v, --videoId=videoId (required) ID of the Video
--context=(Owner|Collaborator) Actor context to execute the command in (Owner/Collaborator)
--useMemberId=useMemberId Try using the specified member id as context whenever possible
--useWorkerId=useWorkerId Try using the specified worker id as context whenever possible
See code: src/commands/content/deleteVideo.ts
joystream-cli content:deleteVideoCategory VIDEOCATEGORYID
Delete video category.
USAGE
$ joystream-cli content:deleteVideoCategory VIDEOCATEGORYID
ARGUMENTS
VIDEOCATEGORYID ID of the Video Category
OPTIONS
--context=(Lead|Curator) Actor context to execute the command in (Lead/Curator)
--useMemberId=useMemberId Try using the specified member id as context whenever possible
--useWorkerId=useWorkerId Try using the specified worker id as context whenever possible
See code: src/commands/content/deleteVideoCategory.ts
joystream-cli content:removeChannelAssets
Remove data objects associated with the channel or any of its videos.
USAGE
$ joystream-cli content:removeChannelAssets
OPTIONS
-c, --channelId=channelId (required) ID of the Channel
-o, --objectId=objectId (required) ID of an object to remove
--context=(Owner|Collaborator) Actor context to execute the command in (Owner/Collaborator)
--useMemberId=useMemberId Try using the specified member id as context whenever possible
--useWorkerId=useWorkerId Try using the specified worker id as context whenever possible
See code: src/commands/content/removeChannelAssets.ts
joystream-cli content:removeCuratorFromGroup [GROUPID] [CURATORID]
Remove Curator from Curator Group.
USAGE
$ joystream-cli content:removeCuratorFromGroup [GROUPID] [CURATORID]
ARGUMENTS
GROUPID ID of the Curator Group
CURATORID ID of the curator
OPTIONS
--useMemberId=useMemberId Try using the specified member id as context whenever possible
--useWorkerId=useWorkerId Try using the specified worker id as context whenever possible
See code: src/commands/content/removeCuratorFromGroup.ts
joystream-cli content:reuploadAssets
Allows reuploading assets that were not successfully uploaded during channel/video creation
USAGE
$ joystream-cli content:reuploadAssets
OPTIONS
-i, --input=input (required) Path to JSON file containing array of assets to reupload (contentIds and paths)
--useMemberId=useMemberId Try using the specified member id as context whenever possible
--useWorkerId=useWorkerId Try using the specified worker id as context whenever possible
See code: src/commands/content/reuploadAssets.ts
joystream-cli content:setCuratorGroupStatus [ID] [STATUS]
Set Curator Group status (Active/Inactive).
USAGE
$ joystream-cli content:setCuratorGroupStatus [ID] [STATUS]
ARGUMENTS
ID ID of the Curator Group
STATUS New status of the group (1 - active, 0 - inactive)
OPTIONS
--useMemberId=useMemberId Try using the specified member id as context whenever possible
--useWorkerId=useWorkerId Try using the specified worker id as context whenever possible
See code: src/commands/content/setCuratorGroupStatus.ts
joystream-cli content:setFeaturedVideos FEATUREDVIDEOIDS
Set featured videos. Requires lead access.
USAGE
$ joystream-cli content:setFeaturedVideos FEATUREDVIDEOIDS
ARGUMENTS
FEATUREDVIDEOIDS Comma-separated video IDs (ie. 1,2,3)
OPTIONS
--useMemberId=useMemberId Try using the specified member id as context whenever possible
--useWorkerId=useWorkerId Try using the specified worker id as context whenever possible
See code: src/commands/content/setFeaturedVideos.ts
joystream-cli content:updateChannel CHANNELID
Update existing content directory channel.
USAGE
$ joystream-cli content:updateChannel CHANNELID
ARGUMENTS
CHANNELID ID of the Channel
OPTIONS
-i, --input=input (required) Path to JSON file to use as input
--context=(Owner|Collaborator) Actor context to execute the command in (Owner/Collaborator)
--useMemberId=useMemberId Try using the specified member id as context whenever possible
--useWorkerId=useWorkerId Try using the specified worker id as context whenever possible
See code: src/commands/content/updateChannel.ts
joystream-cli content:updateChannelCategory CHANNELCATEGORYID
Update channel category inside content directory.
USAGE
$ joystream-cli content:updateChannelCategory CHANNELCATEGORYID
ARGUMENTS
CHANNELCATEGORYID ID of the Channel Category
OPTIONS
-i, --input=input (required) Path to JSON file to use as input
--context=(Lead|Curator) Actor context to execute the command in (Lead/Curator)
--useMemberId=useMemberId Try using the specified member id as context whenever possible
--useWorkerId=useWorkerId Try using the specified worker id as context whenever possible
See code: src/commands/content/updateChannelCategory.ts
joystream-cli content:updateChannelCensorshipStatus ID [STATUS]
Update Channel censorship status (Censored / Not censored).
USAGE
$ joystream-cli content:updateChannelCensorshipStatus ID [STATUS]
ARGUMENTS
ID ID of the Channel
STATUS New censorship status of the channel (1 - censored, 0 - not censored)
OPTIONS
--rationale=rationale rationale
--useMemberId=useMemberId Try using the specified member id as context whenever possible
--useWorkerId=useWorkerId Try using the specified worker id as context whenever possible
See code: src/commands/content/updateChannelCensorshipStatus.ts
joystream-cli content:updateChannelModerators
Update Channel's moderator set.
USAGE
$ joystream-cli content:updateChannelModerators
OPTIONS
-c, --channelId=channelId (required) Channel id
-m, --moderators=moderators New set of moderators
--useMemberId=useMemberId Try using the specified member id as context whenever possible
--useWorkerId=useWorkerId Try using the specified worker id as context whenever possible
EXAMPLE
$ content:updateChannelModerators -c 1 -m 1 2 3
See code: src/commands/content/updateChannelModerators.ts
joystream-cli content:updateVideo VIDEOID
Update video under specific id.
USAGE
$ joystream-cli content:updateVideo VIDEOID
ARGUMENTS
VIDEOID ID of the Video
OPTIONS
-i, --input=input (required) Path to JSON file to use as input
--context=(Owner|Collaborator) Actor context to execute the command in (Owner/Collaborator)
--useMemberId=useMemberId Try using the specified member id as context whenever possible
--useWorkerId=useWorkerId Try using the specified worker id as context whenever possible
See code: src/commands/content/updateVideo.ts
joystream-cli content:updateVideoCategory VIDEOCATEGORYID
Update video category inside content directory.
USAGE
$ joystream-cli content:updateVideoCategory VIDEOCATEGORYID
ARGUMENTS
VIDEOCATEGORYID ID of the Video Category
OPTIONS
-i, --input=input (required) Path to JSON file to use as input
--context=(Lead|Curator) Actor context to execute the command in (Lead/Curator)
--useMemberId=useMemberId Try using the specified member id as context whenever possible
--useWorkerId=useWorkerId Try using the specified worker id as context whenever possible
See code: src/commands/content/updateVideoCategory.ts
joystream-cli content:updateVideoCensorshipStatus ID [STATUS]
Update Video censorship status (Censored / Not censored).
USAGE
$ joystream-cli content:updateVideoCensorshipStatus ID [STATUS]
ARGUMENTS
ID ID of the Video
STATUS New video censorship status (1 - censored, 0 - not censored)
OPTIONS
--rationale=rationale rationale
--useMemberId=useMemberId Try using the specified member id as context whenever possible
--useWorkerId=useWorkerId Try using the specified worker id as context whenever possible
See code: src/commands/content/updateVideoCensorshipStatus.ts
joystream-cli content:video VIDEOID
Show Video details by id.
USAGE
$ joystream-cli content:video VIDEOID
ARGUMENTS
VIDEOID ID of the Video
OPTIONS
--useMemberId=useMemberId Try using the specified member id as context whenever possible
--useWorkerId=useWorkerId Try using the specified worker id as context whenever possible
See code: src/commands/content/video.ts
joystream-cli content:videos [CHANNELID]
List existing content directory videos.
USAGE
$ joystream-cli content:videos [CHANNELID]
ARGUMENTS
CHANNELID ID of the Channel
OPTIONS
--useMemberId=useMemberId Try using the specified member id as context whenever possible
--useWorkerId=useWorkerId Try using the specified worker id as context whenever possible
See code: src/commands/content/videos.ts
joystream-cli forum:addPost
Add forum post.
USAGE
$ joystream-cli forum:addPost
OPTIONS
--categoryId=categoryId (required) Id of the forum category of the parent thread
--editable Whether the post should be editable
--text=text (required) Post content (md-formatted text)
--threadId=threadId (required) Post's parent thread
--useMemberId=useMemberId Try using the specified member id as context whenever possible
--useWorkerId=useWorkerId Try using the specified worker id as context whenever possible
See code: src/commands/forum/addPost.ts
joystream-cli forum:categories
List existing forum categories by parent id (root categories by default) or displays a category tree.
USAGE
$ joystream-cli forum:categories
OPTIONS
-c, --tree Display a category tree (with parentCategoryId as root, if specified)
-p, --parentCategoryId=parentCategoryId Parent category id (only child categories will be listed)
--useMemberId=useMemberId Try using the specified member id as context whenever possible
--useWorkerId=useWorkerId Try using the specified worker id as context whenever possible
See code: src/commands/forum/categories.ts
joystream-cli forum:category
Display forum category details.
USAGE
$ joystream-cli forum:category
OPTIONS
-c, --categoryId=categoryId (required) Forum category id
--useMemberId=useMemberId Try using the specified member id as context whenever possible
--useWorkerId=useWorkerId Try using the specified worker id as context whenever possible
See code: src/commands/forum/category.ts
joystream-cli forum:createCategory
Create forum category.
USAGE
$ joystream-cli forum:createCategory
OPTIONS
-d, --description=description (required) Category description
-p, --parentCategoryId=parentCategoryId Parent category id (in case of creating a subcategory)
-t, --title=title (required) Category title
--useMemberId=useMemberId Try using the specified member id as context whenever possible
--useWorkerId=useWorkerId Try using the specified worker id as context whenever possible
See code: src/commands/forum/createCategory.ts
joystream-cli forum:createThread
Create forum thread.
USAGE
$ joystream-cli forum:createThread
OPTIONS
--categoryId=categoryId (required) Id of the forum category the thread should be created in
--tags=tags Space-separated tags to associate with the thread
--text=text (required) Initial post text
--title=title (required) Thread title
--useMemberId=useMemberId Try using the specified member id as context whenever possible
--useWorkerId=useWorkerId Try using the specified worker id as context whenever possible
See code: src/commands/forum/createThread.ts
joystream-cli forum:deleteCategory
Delete forum category provided it has no existing subcategories and threads.
USAGE
$ joystream-cli forum:deleteCategory
OPTIONS
-c, --categoryId=categoryId (required) Id of the category to delete
--context=(Leader|Moderator) Actor context to execute the command in (Leader/Moderator)
--useMemberId=useMemberId Try using the specified member id as context whenever possible
--useWorkerId=useWorkerId Try using the specified worker id as context whenever possible
See code: src/commands/forum/deleteCategory.ts
joystream-cli forum:moderatePost
Moderate a forum post and slash the associated stake.
USAGE
$ joystream-cli forum:moderatePost
OPTIONS
-c, --categoryId=categoryId (required) Forum category id
-p, --postId=postId (required) Forum post id
-r, --rationale=rationale (required) Rationale behind the post moderation.
-t, --threadId=threadId (required) Forum thread id
--context=(Leader|Moderator) Actor context to execute the command in (Leader/Moderator)
--useMemberId=useMemberId Try using the specified member id as context whenever possible
--useWorkerId=useWorkerId Try using the specified worker id as context whenever possible
See code: src/commands/forum/moderatePost.ts
joystream-cli forum:moderateThread
Moderate a forum thread and slash the associated stake.
USAGE
$ joystream-cli forum:moderateThread
OPTIONS
-c, --categoryId=categoryId (required) Id of the forum category the thread is currently in
-r, --rationale=rationale (required) Rationale behind the thread moderation.
-t, --threadId=threadId (required) Forum thread id
--context=(Leader|Moderator) Actor context to execute the command in (Leader/Moderator)
--useMemberId=useMemberId Try using the specified member id as context whenever possible
--useWorkerId=useWorkerId Try using the specified worker id as context whenever possible
See code: src/commands/forum/moderateThread.ts
joystream-cli forum:moveThread
Move forum thread to a different category.
USAGE
$ joystream-cli forum:moveThread
OPTIONS
-c, --categoryId=categoryId (required) Thread's current category id
-n, --newCategoryId=newCategoryId (required) Thread's new category id
-t, --threadId=threadId (required) Forum thread id
--context=(Leader|Moderator) Actor context to execute the command in (Leader/Moderator)
--useMemberId=useMemberId Try using the specified member id as context whenever possible
--useWorkerId=useWorkerId Try using the specified worker id as context whenever possible
See code: src/commands/forum/moveThread.ts
joystream-cli forum:posts
List existing forum posts in given thread.
USAGE
$ joystream-cli forum:posts
OPTIONS
-t, --threadId=threadId (required) Thread id (only posts in this thread will be listed)
--useMemberId=useMemberId Try using the specified member id as context whenever possible
--useWorkerId=useWorkerId Try using the specified worker id as context whenever possible
See code: src/commands/forum/posts.ts
joystream-cli forum:setStickiedThreads
Set stickied threads in a given category.
USAGE
$ joystream-cli forum:setStickiedThreads
OPTIONS
--categoryId=categoryId (required) Forum category id
--context=(Leader|Moderator) Actor context to execute the command in (Leader/Moderator)
--threadIds=threadIds Space-separated thread ids
--useMemberId=useMemberId Try using the specified member id as context whenever possible
--useWorkerId=useWorkerId Try using the specified worker id as context whenever possible
See code: src/commands/forum/setStickiedThreads.ts
joystream-cli forum:threads
List existing forum threads in given category.
USAGE
$ joystream-cli forum:threads
OPTIONS
-c, --categoryId=categoryId (required) Category id (only threads in this category will be listed)
--useMemberId=useMemberId Try using the specified member id as context whenever possible
--useWorkerId=useWorkerId Try using the specified worker id as context whenever possible
See code: src/commands/forum/threads.ts
joystream-cli forum:updateCategoryArchivalStatus
Update archival status of a forum category.
USAGE
$ joystream-cli forum:updateCategoryArchivalStatus
OPTIONS
-c, --categoryId=categoryId (required) Forum category id
--archived=(yes|no) (required) Whether the category should be archived
--context=(Leader|Moderator) Actor context to execute the command in (Leader/Moderator)
--useMemberId=useMemberId Try using the specified member id as context whenever possible
--useWorkerId=useWorkerId Try using the specified worker id as context whenever possible
See code: src/commands/forum/updateCategoryArchivalStatus.ts
joystream-cli forum:updateCategoryModeratorStatus
Update moderator status of a worker in relation to a category.
USAGE
$ joystream-cli forum:updateCategoryModeratorStatus
OPTIONS
-c, --categoryId=categoryId (required) Forum category id
-w, --workerId=workerId (required) Forum working group worker id
--status=(active|disabled) (required) Status of the moderator membership in the category
--useMemberId=useMemberId Try using the specified member id as context whenever possible
--useWorkerId=useWorkerId Try using the specified worker id as context whenever possible
See code: src/commands/forum/updateCategoryModeratorStatus.ts
joystream-cli help [COMMAND]
display help for joystream-cli
USAGE
$ joystream-cli help [COMMAND]
ARGUMENTS
COMMAND command to show help for
OPTIONS
--all see all commands in CLI
See code: @oclif/plugin-help
joystream-cli membership:addStakingAccount
Associate a new staking account with an existing membership.
USAGE
$ joystream-cli membership:addStakingAccount
OPTIONS
--address=address Address of the staking account to be associated with the member
--fundsSource=fundsSource If provided, this account will be used as funds source for the purpose of initializing the
staking accout
--useMemberId=useMemberId Try using the specified member id as context whenever possible
--withBalance=withBalance Allows optionally specifying required initial balance for the staking account
See code: src/commands/membership/addStakingAccount.ts
joystream-cli membership:buy
Buy / register a new membership on the Joystream platform.
USAGE
$ joystream-cli membership:buy
OPTIONS
--about=about Member's md-formatted about text (bio)
--avatarUri=avatarUri Member's avatar uri
--controllerKey=controllerKey Member's controller key. Can also be provided interactively.
--handle=handle (required) Member's handle
--name=name Member's first name / full name
--rootKey=rootKey Member's root key. Can also be provided interactively.
--senderKey=senderKey Tx sender key. If not provided, controllerKey will be used by default.
ALIASES
$ joystream-cli membership:create
$ joystream-cli membership:register
See code: src/commands/membership/buy.ts
joystream-cli membership:details
Display membership details by specified memberId.
USAGE
$ joystream-cli membership:details
OPTIONS
-m, --memberId=memberId (required) Member id
ALIASES
$ joystream-cli membership:info
$ joystream-cli membership:inspect
$ joystream-cli membership:show
See code: src/commands/membership/details.ts
joystream-cli membership:update
Update existing membership metadata and/or handle.
USAGE
$ joystream-cli membership:update
OPTIONS
--newAbout=newAbout Member's new md-formatted about text (bio)
--newAvatarUri=newAvatarUri Member's new avatar uri
--newHandle=newHandle Member's new handle
--newName=newName Member's new first name / full name
--useMemberId=useMemberId Try using the specified member id as context whenever possible
See code: src/commands/membership/update.ts
joystream-cli membership:updateAccounts
Update existing membership accounts/keys (root / controller).
USAGE
$ joystream-cli membership:updateAccounts
OPTIONS
--newControllerAccount=newControllerAccount Member's new controller account/key
--newRootAccount=newRootAccount Member's new root account/key
--useMemberId=useMemberId Try using the specified member id as context whenever possible
See code: src/commands/membership/updateAccounts.ts
joystream-cli staking:validate
Start validating. Takes the controller key.
USAGE
$ joystream-cli staking:validate
OPTIONS
--commission=commission Set a commission (0-100), which is deducted from all rewards before the remainder is split
with nominator
--controller=controller The controller key you want to validate with.
See code: src/commands/staking/validate.ts
joystream-cli working-groups:application WGAPPLICATIONID
Shows an overview of given application by Working Group Application ID
USAGE
$ joystream-cli working-groups:application WGAPPLICATIONID
ARGUMENTS
WGAPPLICATIONID Working Group Application ID
OPTIONS
-g, --group=(storageProviders|curators|forum|membership|gateway|builders|humanResources|marketing|distributors)
The working group context in which the command should be executed
Available values are: storageProviders, curators, forum, membership, gateway, builders, humanResources, marketing,
distributors.
--useMemberId=useMemberId
Try using the specified member id as context whenever possible
--useWorkerId=useWorkerId
Try using the specified worker id as context whenever possible
See code: src/commands/working-groups/application.ts
joystream-cli working-groups:apply
Apply to a working group opening (requires a membership)
USAGE
$ joystream-cli working-groups:apply
OPTIONS
-g, --group=(storageProviders|curators|forum|membership|gateway|builders|humanResources|marketing|distributors)
The working group context in which the command should be executed
Available values are: storageProviders, curators, forum, membership, gateway, builders, humanResources, marketing,
distributors.
--answers=answers
Answers for opening's application form questions (sorted by question index)
--openingId=openingId
(required) Opening ID
--rewardAccount=rewardAccount
Future worker reward account
--roleAccount=roleAccount
Future worker role account
--stakingAccount=stakingAccount
Account to hold applicant's / worker's stake
--useMemberId=useMemberId
Try using the specified member id as context whenever possible
--useWorkerId=useWorkerId
Try using the specified worker id as context whenever possible
See code: src/commands/working-groups/apply.ts
joystream-cli working-groups:cancelOpening OPENINGID
Cancels (removes) an active opening
USAGE
$ joystream-cli working-groups:cancelOpening OPENINGID
ARGUMENTS
OPENINGID Opening ID
OPTIONS
-g, --group=(storageProviders|curators|forum|membership|gateway|builders|humanResources|marketing|distributors)
The working group context in which the command should be executed
Available values are: storageProviders, curators, forum, membership, gateway, builders, humanResources, marketing,
distributors.
--useMemberId=useMemberId
Try using the specified member id as context whenever possible
--useWorkerId=useWorkerId
Try using the specified worker id as context whenever possible
See code: src/commands/working-groups/cancelOpening.ts
joystream-cli working-groups:createOpening
Create working group opening / upcoming opening (requires lead access)
USAGE
$ joystream-cli working-groups:createOpening
OPTIONS
-e, --edit
If provided along with --input - launches in edit mode allowing to modify the input before sending the exstinsic
-g, --group=(storageProviders|curators|forum|membership|gateway|builders|humanResources|marketing|distributors)
The working group context in which the command should be executed
Available values are: storageProviders, curators, forum, membership, gateway, builders, humanResources, marketing,
distributors.
-i, --input=input
Path to JSON file to use as input (if not specified - the input can be provided interactively)
-o, --output=output
Path to the file where the output JSON should be saved (this output can be then reused as input)
--dryRun
If provided along with --output - skips sending the actual extrinsic(can be used to generate a "draft" which can be
provided as input later)
--stakeTopUpSource=stakeTopUpSource
If provided - this account (key) will be used as default funds source for lead stake top up (in case it's needed)
--startsAt=startsAt
If upcoming opening - the expected opening start date (YYYY-MM-DD HH:mm:ss)
--upcoming
Whether the opening should be an upcoming opening
--useMemberId=useMemberId
Try using the specified member id as context whenever possible
--useWorkerId=useWorkerId
Try using the specified worker id as context whenever possible
See code: src/commands/working-groups/createOpening.ts
joystream-cli working-groups:decreaseWorkerStake WORKERID AMOUNT
Decreases given worker stake by an amount that will be returned to the worker role account. Requires lead access.
USAGE
$ joystream-cli working-groups:decreaseWorkerStake WORKERID AMOUNT
ARGUMENTS
WORKERID Worker ID
AMOUNT Amount of JOY to decrease the current worker stake by
OPTIONS
-g, --group=(storageProviders|curators|forum|membership|gateway|builders|humanResources|marketing|distributors)
The working group context in which the command should be executed
Available values are: storageProviders, curators, forum, membership, gateway, builders, humanResources, marketing,
distributors.
--useMemberId=useMemberId
Try using the specified member id as context whenever possible
--useWorkerId=useWorkerId
Try using the specified worker id as context whenever possible
See code: src/commands/working-groups/decreaseWorkerStake.ts
joystream-cli working-groups:evictWorker WORKERID
Evicts given worker. Requires lead access.
USAGE
$ joystream-cli working-groups:evictWorker WORKERID
ARGUMENTS
WORKERID Worker ID
OPTIONS
-g, --group=(storageProviders|curators|forum|membership|gateway|builders|humanResources|marketing|distributors)
The working group context in which the command should be executed
Available values are: storageProviders, curators, forum, membership, gateway, builders, humanResources, marketing,
distributors.
--penalty=penalty
Optional penalty in JOY
--rationale=rationale
Optional rationale
--useMemberId=useMemberId
Try using the specified member id as context whenever possible
--useWorkerId=useWorkerId
Try using the specified worker id as context whenever possible
See code: src/commands/working-groups/evictWorker.ts
joystream-cli working-groups:fillOpening
Allows filling working group opening that's currently in review. Requires lead access.
USAGE
$ joystream-cli working-groups:fillOpening
OPTIONS
-g, --group=(storageProviders|curators|forum|membership|gateway|builders|humanResources|marketing|distributors)
The working group context in which the command should be executed
Available values are: storageProviders, curators, forum, membership, gateway, builders, humanResources, marketing,
distributors.
--applicationIds=applicationIds
Accepted application ids
--openingId=openingId
(required) Working Group Opening ID
--useMemberId=useMemberId
Try using the specified member id as context whenever possible
--useWorkerId=useWorkerId
Try using the specified worker id as context whenever possible
See code: src/commands/working-groups/fillOpening.ts
joystream-cli working-groups:increaseStake AMOUNT
Increases current role (lead/worker) stake. Requires active role account to be selected.
USAGE
$ joystream-cli working-groups:increaseStake AMOUNT
ARGUMENTS
AMOUNT Amount of JOY to increase the current stake by
OPTIONS
-g, --group=(storageProviders|curators|forum|membership|gateway|builders|humanResources|marketing|distributors)
The working group context in which the command should be executed
Available values are: storageProviders, curators, forum, membership, gateway, builders, humanResources, marketing,
distributors.
--useMemberId=useMemberId
Try using the specified member id as context whenever possible
--useWorkerId=useWorkerId
Try using the specified worker id as context whenever possible
See code: src/commands/working-groups/increaseStake.ts
joystream-cli working-groups:leaveRole
Leave the worker or lead role associated with currently selected account.
USAGE
$ joystream-cli working-groups:leaveRole
OPTIONS
-g, --group=(storageProviders|curators|forum|membership|gateway|builders|humanResources|marketing|distributors)
The working group context in which the command should be executed
Available values are: storageProviders, curators, forum, membership, gateway, builders, humanResources, marketing,
distributors.
--rationale=rationale
--useMemberId=useMemberId
Try using the specified member id as context whenever possible
--useWorkerId=useWorkerId
Try using the specified worker id as context whenever possible
See code: src/commands/working-groups/leaveRole.ts
joystream-cli working-groups:opening
Shows detailed information about working group opening / upcoming opening by id
USAGE
$ joystream-cli working-groups:opening
OPTIONS
-g, --group=(storageProviders|curators|forum|membership|gateway|builders|humanResources|marketing|distributors)
The working group context in which the command should be executed
Available values are: storageProviders, curators, forum, membership, gateway, builders, humanResources, marketing,
distributors.
--id=id
(required) Opening / upcoming opening id (depending on --upcoming flag)
--upcoming
Whether the opening is an upcoming opening
--useMemberId=useMemberId
Try using the specified member id as context whenever possible
--useWorkerId=useWorkerId
Try using the specified worker id as context whenever possible
See code: src/commands/working-groups/opening.ts
joystream-cli working-groups:openings
Lists active/upcoming openings in a given working group
USAGE
$ joystream-cli working-groups:openings
OPTIONS
-g, --group=(storageProviders|curators|forum|membership|gateway|builders|humanResources|marketing|distributors)
The working group context in which the command should be executed
Available values are: storageProviders, curators, forum, membership, gateway, builders, humanResources, marketing,
distributors.
--upcoming
List upcoming openings (active openings are listed by default)
--useMemberId=useMemberId
Try using the specified member id as context whenever possible
--useWorkerId=useWorkerId
Try using the specified worker id as context whenever possible
See code: src/commands/working-groups/openings.ts
joystream-cli working-groups:overview
Shows an overview of given working group (current lead and workers)
USAGE
$ joystream-cli working-groups:overview
OPTIONS
-g, --group=(storageProviders|curators|forum|membership|gateway|builders|humanResources|marketing|distributors)
The working group context in which the command should be executed
Available values are: storageProviders, curators, forum, membership, gateway, builders, humanResources, marketing,
distributors.
--useMemberId=useMemberId
Try using the specified member id as context whenever possible
--useWorkerId=useWorkerId
Try using the specified worker id as context whenever possible
See code: src/commands/working-groups/overview.ts
joystream-cli working-groups:removeUpcomingOpening
Remove an existing upcoming opening by sending RemoveUpcomingOpening metadata signal (requires lead access)
USAGE
$ joystream-cli working-groups:removeUpcomingOpening
OPTIONS
-g, --group=(storageProviders|curators|forum|membership|gateway|builders|humanResources|marketing|distributors)
The working group context in which the command should be executed
Available values are: storageProviders, curators, forum, membership, gateway, builders, humanResources, marketing,
distributors.
-i, --id=id
(required) Id of the upcoming opening to remove
--useMemberId=useMemberId
Try using the specified member id as context whenever possible
--useWorkerId=useWorkerId
Try using the specified worker id as context whenever possible
See code: src/commands/working-groups/removeUpcomingOpening.ts
joystream-cli working-groups:setDefaultGroup
Change the default group context for working-groups commands.
USAGE
$ joystream-cli working-groups:setDefaultGroup
OPTIONS
-g, --group=(storageProviders|curators|forum|membership|gateway|builders|humanResources|marketing|distributors)
The working group context in which the command should be executed
Available values are: storageProviders, curators, forum, membership, gateway, builders, humanResources, marketing,
distributors.
--useMemberId=useMemberId
Try using the specified member id as context whenever possible
--useWorkerId=useWorkerId
Try using the specified worker id as context whenever possible
See code: src/commands/working-groups/setDefaultGroup.ts
joystream-cli working-groups:slashWorker WORKERID AMOUNT
Slashes given worker stake. Requires lead access.
USAGE
$ joystream-cli working-groups:slashWorker WORKERID AMOUNT
ARGUMENTS
WORKERID Worker ID
AMOUNT Slash amount
OPTIONS
-g, --group=(storageProviders|curators|forum|membership|gateway|builders|humanResources|marketing|distributors)
The working group context in which the command should be executed
Available values are: storageProviders, curators, forum, membership, gateway, builders, humanResources, marketing,
distributors.
--rationale=rationale
--useMemberId=useMemberId
Try using the specified member id as context whenever possible
--useWorkerId=useWorkerId
Try using the specified worker id as context whenever possible
See code: src/commands/working-groups/slashWorker.ts
joystream-cli working-groups:updateGroupMetadata
Update working group metadata (description, status etc.). The update will be atomic (just like video / channel metadata updates)
USAGE
$ joystream-cli working-groups:updateGroupMetadata
OPTIONS
-g, --group=(storageProviders|curators|forum|membership|gateway|builders|humanResources|marketing|distributors)
The working group context in which the command should be executed
Available values are: storageProviders, curators, forum, membership, gateway, builders, humanResources, marketing,
distributors.
-i, --input=input
(required) Path to JSON file to use as input
--useMemberId=useMemberId
Try using the specified member id as context whenever possible
--useWorkerId=useWorkerId
Try using the specified worker id as context whenever possible
See code: src/commands/working-groups/updateGroupMetadata.ts
joystream-cli working-groups:updateRewardAccount [ADDRESS]
Updates the worker/lead reward account (requires current role account to be selected)
USAGE
$ joystream-cli working-groups:updateRewardAccount [ADDRESS]
ARGUMENTS
ADDRESS New reward account address (if omitted, can be provided interactivel)
OPTIONS
-g, --group=(storageProviders|curators|forum|membership|gateway|builders|humanResources|marketing|distributors)
The working group context in which the command should be executed
Available values are: storageProviders, curators, forum, membership, gateway, builders, humanResources, marketing,
distributors.
--useMemberId=useMemberId
Try using the specified member id as context whenever possible
--useWorkerId=useWorkerId
Try using the specified worker id as context whenever possible
See code: src/commands/working-groups/updateRewardAccount.ts
joystream-cli working-groups:updateRoleAccount [ADDRESS]
Updates the worker/lead role account. Requires member controller account to be selected
USAGE
$ joystream-cli working-groups:updateRoleAccount [ADDRESS]
ARGUMENTS
ADDRESS New role account address (if omitted, can be provided interactively)
OPTIONS
-g, --group=(storageProviders|curators|forum|membership|gateway|builders|humanResources|marketing|distributors)
The working group context in which the command should be executed
Available values are: storageProviders, curators, forum, membership, gateway, builders, humanResources, marketing,
distributors.
--useMemberId=useMemberId
Try using the specified member id as context whenever possible
--useWorkerId=useWorkerId
Try using the specified worker id as context whenever possible
See code: src/commands/working-groups/updateRoleAccount.ts
joystream-cli working-groups:updateRoleStorage STORAGE
Updates the associated worker storage
USAGE
$ joystream-cli working-groups:updateRoleStorage STORAGE
ARGUMENTS
STORAGE Worker storage
OPTIONS
-g, --group=(storageProviders|curators|forum|membership|gateway|builders|humanResources|marketing|distributors)
The working group context in which the command should be executed
Available values are: storageProviders, curators, forum, membership, gateway, builders, humanResources, marketing,
distributors.
--useMemberId=useMemberId
Try using the specified member id as context whenever possible
--useWorkerId=useWorkerId
Try using the specified worker id as context whenever possible
See code: src/commands/working-groups/updateRoleStorage.ts
joystream-cli working-groups:updateWorkerReward WORKERID NEWREWARD
Change given worker's reward (amount only). Requires lead access.
USAGE
$ joystream-cli working-groups:updateWorkerReward WORKERID NEWREWARD
ARGUMENTS
WORKERID Worker ID
NEWREWARD New reward
OPTIONS
-g, --group=(storageProviders|curators|forum|membership|gateway|builders|humanResources|marketing|distributors)
The working group context in which the command should be executed
Available values are: storageProviders, curators, forum, membership, gateway, builders, humanResources, marketing,
distributors.
--useMemberId=useMemberId
Try using the specified member id as context whenever possible
--useWorkerId=useWorkerId
Try using the specified worker id as context whenever possible