@joystream/cli
Advanced tools
Command Line Interface for Joystream community and governance activities
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/1.5.1 darwin-arm64 node-v18.6.0
$ 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:createjoystream-cli account:export DESTPATHjoystream-cli account:forgetjoystream-cli account:importjoystream-cli account:info [ADDRESS]joystream-cli account:listjoystream-cli account:transferTokensjoystream-cli advanced-transactions:constructSetCodeCalljoystream-cli advanced-transactions:constructTxCalljoystream-cli advanced-transactions:constructUnsignedTxjoystream-cli advanced-transactions:constructUnsignedTxApproveMsjoystream-cli advanced-transactions:constructUnsignedTxFinalApproveMsjoystream-cli advanced-transactions:constructUnsignedTxInitiateMsjoystream-cli advanced-transactions:constructWrappedTxCalljoystream-cli api:getQueryNodeEndpointjoystream-cli api:getUrijoystream-cli api:inspectjoystream-cli api:setQueryNodeEndpoint [ENDPOINT]joystream-cli api:setUri [URI]joystream-cli apps:createAppjoystream-cli apps:updateAppjoystream-cli autocomplete [SHELL]joystream-cli content:addCuratorToGroup [GROUPID] [CURATORID]joystream-cli content:channel CHANNELIDjoystream-cli content:channelPayoutProof CHANNELIDjoystream-cli content:channelPayoutProofAtByteOffset BYTEOFFSETjoystream-cli content:channelPayoutsPayloadHeaderjoystream-cli content:channelsjoystream-cli content:claimChannelReward CHANNELIDjoystream-cli content:createChanneljoystream-cli content:createCuratorGroupjoystream-cli content:createVideojoystream-cli content:createVideoCategory NAME [DESCRIPTION] [PARENTCATEGORYID]joystream-cli content:curatorGroup IDjoystream-cli content:curatorGroupsjoystream-cli content:deleteChanneljoystream-cli content:deleteChannelAssetsAsModeratorjoystream-cli content:deleteVideojoystream-cli content:deleteVideoAssetsAsModeratorjoystream-cli content:directChannelPaymentjoystream-cli content:generateChannelPayoutsCommitmentjoystream-cli content:generateChannelPayoutsPayloadjoystream-cli content:getPayoutsOnchainCommitmentjoystream-cli content:removeChannelAssetsjoystream-cli content:removeCuratorFromGroup [GROUPID] [CURATORID]joystream-cli content:reuploadAssetsjoystream-cli content:setChannelVisibilityAsModeratorjoystream-cli content:setCuratorGroupStatus [ID] [STATUS]joystream-cli content:setVideoVisibilityAsModeratorjoystream-cli content:updateChannel CHANNELIDjoystream-cli content:updateChannelPayoutsProposaljoystream-cli content:updateChannelStateBloatBond VALUEjoystream-cli content:updateCuratorGroupPermissions [ID]joystream-cli content:updateVideo VIDEOIDjoystream-cli content:updateVideoStateBloatBond VALUEjoystream-cli content:video VIDEOIDjoystream-cli content:videos [CHANNELID]joystream-cli council:fundBudgetjoystream-cli fee-profile:addForumPostjoystream-cli fee-profile:addVideoCommentjoystream-cli fee-profile:buyMembershipjoystream-cli fee-profile:createChanneljoystream-cli fee-profile:createForumThreadjoystream-cli fee-profile:createVideojoystream-cli fee-profile:deleteChanneljoystream-cli fee-profile:deleteForumPostjoystream-cli fee-profile:deleteForumThreadjoystream-cli fee-profile:deleteVideojoystream-cli forum:addPostjoystream-cli forum:categoriesjoystream-cli forum:categoryjoystream-cli forum:createCategoryjoystream-cli forum:createThreadjoystream-cli forum:deleteCategoryjoystream-cli forum:moderatePostjoystream-cli forum:moderateThreadjoystream-cli forum:moveThreadjoystream-cli forum:postsjoystream-cli forum:setStickiedThreadsjoystream-cli forum:threadsjoystream-cli forum:updateCategoryArchivalStatusjoystream-cli forum:updateCategoryModeratorStatusjoystream-cli help [COMMAND]joystream-cli membership:addStakingAccountjoystream-cli membership:buyjoystream-cli membership:detailsjoystream-cli membership:memberRemark MESSAGEjoystream-cli membership:updatejoystream-cli membership:updateAccountsjoystream-cli sign-offline:signUnsignedTxjoystream-cli staking:validatejoystream-cli util:decodeMessagejoystream-cli util:encodeMessagejoystream-cli util:messageStructurejoystream-cli working-groups:application WGAPPLICATIONIDjoystream-cli working-groups:applyjoystream-cli working-groups:cancelOpening OPENINGIDjoystream-cli working-groups:createOpeningjoystream-cli working-groups:decreaseWorkerStake WORKERID AMOUNTjoystream-cli working-groups:evictWorker WORKERIDjoystream-cli working-groups:fillOpeningjoystream-cli working-groups:increaseStake AMOUNTjoystream-cli working-groups:leaveRolejoystream-cli working-groups:openingjoystream-cli working-groups:openingsjoystream-cli working-groups:overviewjoystream-cli working-groups:removeUpcomingOpeningjoystream-cli working-groups:setDefaultGroupjoystream-cli working-groups:slashWorker WORKERID AMOUNTjoystream-cli working-groups:updateGroupMetadatajoystream-cli working-groups:updateRewardAccount [ADDRESS]joystream-cli working-groups:updateRoleAccount [ADDRESS]joystream-cli working-groups:updateWorkerReward WORKERID NEWREWARDjoystream-cli working-groups:verifyValidator MEMBERIDjoystream-cli account:createCreate 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 DESTPATHExport 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:forgetForget (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:importImport 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:listList all available accounts
USAGE
$ joystream-cli account:list
See code: src/commands/account/list.ts
joystream-cli account:transferTokensTransfer 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 advanced-transactions:constructSetCodeCallConstruct a "system.setCode" call.
USAGE
$ joystream-cli advanced-transactions:constructSetCodeCall
OPTIONS
-o, --output=output (required) Path to the file where the call should be saved
--address=address (required) The address that is performing the final call.
--codeOutput=codeOutput Path to where the parsed wasm code shold be saved.
--lifetime=lifetime [default: 64] Lifetime of the transaction, from creation to included on chain, in
blocks before it becomes invalid.
--nonceIncrement=nonceIncrement [default: 0] If you are preparing multiple transactions from the samme account,
before broadcasting them, you need to increase the nonce by 1 for each. This value
will be added to the nonce read from the chain.
--tip=tip [default: 0] Optional "tip" (in base value) for faster block inclusion.
--wasmPath=wasmPath (required) The address that is performing the final call.
See code: src/commands/advanced-transactions/constructSetCodeCall.ts
joystream-cli advanced-transactions:constructTxCallConstruct a call that as argument for a transaction, or to wrap in another call.
USAGE
$ joystream-cli advanced-transactions:constructTxCall
OPTIONS
-o, --output=output (required) Path to the file where the output JSON should be saved.
--address=address (required) The address that is performing the (final) transaction.
--lifetime=lifetime [default: 64] Lifetime of the transaction, from creation to included on chain, in
blocks before it becomes invalid.
--method=method (required) The method of the extrinsic
--module=module (required) The module (a.k.a. section) of the extrinsic
--nonceIncrement=nonceIncrement [default: 0] If you are preparing multiple transactions from the samme account,
before broadcasting them, you need to increase the nonce by 1 for each. This value
will be added to the nonce read from the chain.
--tip=tip [default: 0] Optional "tip" (in base value) for faster block inclusion.
See code: src/commands/advanced-transactions/constructTxCall.ts
joystream-cli advanced-transactions:constructUnsignedTxCreate a simple unsigned transaction, for signing offline.
USAGE
$ joystream-cli advanced-transactions:constructUnsignedTx
OPTIONS
-o, --output=output (required) Path to the file where the output JSON should be saved.
--address=address (required) The address that is performing the transaction.
--lifetime=lifetime Lifetime of the transaction, from constructed to included in a block, in blocks
before it becomes invalid. Must be a power of two between 4 and 65536
--method=method (required) The method of the extrinsic
--module=module (required) The module of the extrinsic
--nonceIncrement=nonceIncrement [default: 0] If you are preparing multiple transactions from the samme account,
before broadcasting them, you need to increase the nonce by 1 for each. This value
will be added to the nonce read from the chain.
--tip=tip [default: 0] Optional "tip" (in base value) for faster block inclusion.
See code: src/commands/advanced-transactions/constructUnsignedTx.ts
joystream-cli advanced-transactions:constructUnsignedTxApproveMsApprove a transaction from a multisig account, as initiated by another signer.
USAGE
$ joystream-cli advanced-transactions:constructUnsignedTxApproveMs
OPTIONS
-i, --input=input Path to JSON file to use as input (if not specified - the input can be provided
interactively)
-o, --output=output (required) Path to the file where the output JSON should be saved.
--addressMs=addressMs The address of the multisig that is performing the transaction.
--addressSigner=addressSigner (required) The address of the signer that is approving the multisig transaction.
--inputCall=inputCall The hex-encoded call that is to be executed by the multisig if successfull.
--inputCallFile=inputCallFile Path to a JSON file with the hex-encoded call that is to be executed by the
multisig if successfull.
--lifetime=lifetime Lifetime of the transaction, from constructed to included in a block, in blocks
before it becomes invalid. Must be a power of two between 4 and 65536
--nonceIncrement=nonceIncrement [default: 0] If you are preparing multiple transactions from the samme account,
before broadcasting them, you need to increase the nonce by 1 for each. This value
will be added to the nonce read from the chain.
--others=others Comma separated list of the accounts (other than the addressSigner) who can approve
this call. Ignored if "input" is provided.
--threshold=threshold How many (m) of the n signatories (signer+others), are required to sign/approve the
transaction. Ignored if "input" is provided.
--timepointHeight=timepointHeight Reference to the blockheight of the transaction that initiated the multisig
transaction. Ignored if "input" is provided.
--timepointIndex=timepointIndex Reference to the extrinsic index in the "timepointHeight block. Ignored if "input"
is provided.
--tip=tip [default: 0] Optional "tip" (in base value) for faster block inclusion.
See code: src/commands/advanced-transactions/constructUnsignedTxApproveMs.ts
joystream-cli advanced-transactions:constructUnsignedTxFinalApproveMsFinal approval of a transaction from a multisig account, as initiated by another signer.
USAGE
$ joystream-cli advanced-transactions:constructUnsignedTxFinalApproveMs
OPTIONS
-i, --input=input Path to JSON file to use as input (if not specified - the input can be provided
interactively)
-o, --output=output (required) Path to the file where the output JSON should be saved.
--addressMs=addressMs The address of the multisig that is performing the transaction.
--addressSigner=addressSigner (required) The address of the signer that is approving the multisig transaction.
--inputCall=inputCall The hex-encoded call that is to be executed by the multisig if successfull.
--inputCallFile=inputCallFile Path to a JSON file with the hex-encoded call that is to be executed by the
multisig if successfull.
--lifetime=lifetime Lifetime of the transaction, from constructed to included in a block, in blocks
before it becomes invalid. Must be a power of two between 4 and 65536
--nonceIncrement=nonceIncrement [default: 0] If you are preparing multiple transactions from the samme account,
before broadcasting them, you need to increase the nonce by 1 for each. This value
will be added to the nonce read from the chain.
--others=others Comma separated list of the accounts (other than the addressSigner) who can approve
this call. Ignored if "input" is provided.
--threshold=threshold How many (m) of the n signatories (signer+others), are required to sign/approve the
transaction. Ignored if "input" is provided.
--timepointHeight=timepointHeight Reference to the blockheight of the transaction that initiated the multisig
transaction. Ignored if "input" is provided.
--timepointIndex=timepointIndex Reference to the extrinsic index in the "timepointHeight block. Ignored if "input"
is provided.
--tip=tip [default: 0] Optional "tip" (in base value) for faster block inclusion.
See code: src/commands/advanced-transactions/constructUnsignedTxFinalApproveMs.ts
joystream-cli advanced-transactions:constructUnsignedTxInitiateMsInitiate a call (transaction) from a multisig account, as the first signer.
USAGE
$ joystream-cli advanced-transactions:constructUnsignedTxInitiateMs
OPTIONS
-i, --input=input Path to JSON file to use as input (if not specified - the input can be provided
interactively)
-o, --output=output (required) Path to the file where the output JSON should be saved.
--addressMs=addressMs The address of the multisig that is performing the transaction.
--addressSigner=addressSigner (required) The address of the signer that is initiating the multisig transaction.
--inputCall=inputCall The hex-encoded call that is to be executed by the multisig if successfull.
--inputCallFile=inputCallFile Path to a JSON file with the hex-encoded call that is to be executed by the multisig
if successfull.
--lifetime=lifetime Lifetime of the transaction, from constructed to included in a block, in blocks
before it becomes invalid. Must be a power of two between 4 and 65536
--nonceIncrement=nonceIncrement [default: 0] If you are preparing multiple transactions from the samme account,
before broadcasting them, you need to increase the nonce by 1 for each. This value
will be added to the nonce read from the chain.
--others=others Comma separated list of the accounts (other than the addressSigner) who can approve
this call. Ignored if "input" is provided.
--threshold=threshold How many (m) of the n signatories (signer+others), are required to sign/approve the
transaction. Ignored if "input" is provided.
--tip=tip [default: 0] Optional "tip" (in base value) for faster block inclusion.
See code: src/commands/advanced-transactions/constructUnsignedTxInitiateMs.ts
joystream-cli advanced-transactions:constructWrappedTxCallConstruct a wrapped transaction call.
USAGE
$ joystream-cli advanced-transactions:constructWrappedTxCall
OPTIONS
-o, --output=output (required) Path to the file where the output JSON should be saved.
--address=address (required) The address that is performing the (final) transaction.
--fullOutput=fullOutput Path to the file where the full output should be saved
--inputCall=inputCall The hex-encoded call that is to be executed by the multisig if successfull.
--inputCallFile=inputCallFile Path to a JSON file with the hex-encoded call that is to be executed by the multisig
if successfull.
--lifetime=lifetime [default: 64] Lifetime of the transaction, from creation to included on chain, in
blocks before it becomes invalid.
--method=method (required) The method of the extrinsic
--module=module (required) The module (a.k.a. section) of the extrinsic
--nonceIncrement=nonceIncrement [default: 0] If you are preparing multiple transactions from the samme account,
before broadcasting them, you need to increase the nonce by 1 for each. This value
will be added to the nonce read from the chain.
--tip=tip [default: 0] Optional "tip" (in base value) for faster block inclusion.
See code: src/commands/advanced-transactions/constructWrappedTxCall.ts
joystream-cli api:getQueryNodeEndpointGet current query node endpoint
USAGE
$ joystream-cli api:getQueryNodeEndpoint
See code: src/commands/api/getQueryNodeEndpoint.ts
joystream-cli api:getUriGet current api WS provider uri
USAGE
$ joystream-cli api:getUri
See code: src/commands/api/getUri.ts
joystream-cli api:inspectLists 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 apps:createAppCreates app for current member
USAGE
$ joystream-cli apps:createApp
OPTIONS
-i, --input=input Path to JSON file containing app details
-s, --skip If true command won't prompt missing fields
--useMemberId=useMemberId Try using the specified member id as context whenever possible
See code: src/commands/apps/createApp.ts
joystream-cli apps:updateAppUpdates app of given ID
USAGE
$ joystream-cli apps:updateApp
OPTIONS
-i, --input=input Path to JSON file containing app details
-s, --skip If true command won't prompt missing fields
--appId=appId (required) ID of the app to update
--useMemberId=useMemberId Try using the specified member id as context whenever possible
See code: src/commands/apps/updateApp.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
-p,
--permissions=UpdateChannelMetadata|ManageNonVideoChannelAssets|ManageChannelCollaborators|UpdateVideoMetadata|AddVide
o|ManageVideoAssets|DeleteChannel|DeleteVideo|ManageVideoNfts|AgentRemark|TransferChannel|ClaimChannelReward|WithdrawF
romChannelBalance|IssueCreatorToken|ClaimCreatorTokenPatronage|InitAndManageCreatorTokenSale|CreatorTokenIssuerTransfe
r|MakeCreatorTokenPermissionless|ReduceCreatorTokenPatronageRate|ManageRevenueSplits|DeissueCreatorToken|AmmControl
List of permissions to associate with the curator, e.g. -p ManageChannelCollaborators UpdateVideoMetadata
--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 CHANNELIDShow 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:channelPayoutProof CHANNELIDShow payout information for a channel.
USAGE
$ joystream-cli content:channelPayoutProof 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/channelPayoutProof.ts
joystream-cli content:channelPayoutProofAtByteOffset BYTEOFFSETGet channel payout record from serialized payload at given byte.
USAGE
$ joystream-cli content:channelPayoutProofAtByteOffset BYTEOFFSET
ARGUMENTS
BYTEOFFSET Byte offset of payout record from start of payload
OPTIONS
--path=path Path to the serialized payload file
--url=url URL to the serialized payload file
See code: src/commands/content/channelPayoutProofAtByteOffset.ts
joystream-cli content:channelPayoutsPayloadHeaderGet header from serialized payload file.
USAGE
$ joystream-cli content:channelPayoutsPayloadHeader
OPTIONS
--path=path Path to the protobuf serialized payload file
--url=url URL to the protobuf serialized payload file
See code: src/commands/content/channelPayoutsPayloadHeader.ts
joystream-cli content:channelsList 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:claimChannelReward CHANNELIDClaim channel payout reward for a given channel id.
USAGE
$ joystream-cli content:claimChannelReward 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/claimChannelReward.ts
joystream-cli content:createChannelCreate channel inside content directory.
USAGE
$ joystream-cli content:createChannel
OPTIONS
-i, --input=input (required) Path to JSON file to use as input
--context=(Member|CuratorGroup) Actor context to execute the command in (Member/CuratorGroup)
--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:createCuratorGroupCreate new Curator Group.
USAGE
$ joystream-cli content:createCuratorGroup
OPTIONS
-p, --permissions=permissions Path to JSON file containing moderation permissions by channel privilege level to use
as input
--status=(ACTIVE|INACTIVE) (required) Status of newly created Curator Group: (ACTIVE/INACTIVE)
--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/createCuratorGroup.ts
joystream-cli content:createVideoCreate video (non nft) 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|Curator|Collaborator) Actor context to execute the command in (Owner/Curator/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 NAME [DESCRIPTION] [PARENTCATEGORYID]Create video category inside content directory.
USAGE
$ joystream-cli content:createVideoCategory NAME [DESCRIPTION] [PARENTCATEGORYID]
ARGUMENTS
NAME Video category name
DESCRIPTION Video category description
PARENTCATEGORYID Parent category ID
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/createVideoCategory.ts
joystream-cli content:curatorGroup IDShow 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:curatorGroupsList 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:deleteChannelDelete 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
--context=(Owner|Curator|Collaborator) Actor context to execute the command in (Owner/Curator/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/deleteChannel.ts
joystream-cli content:deleteChannelAssetsAsModeratorDelete the channel assets.
USAGE
$ joystream-cli content:deleteChannelAssetsAsModerator
OPTIONS
-a, --assetIds=assetIds (required) List of data object IDs to delete
-c, --channelId=channelId (required) ID of the Channel
-r, --rationale=rationale (required) Reason for removing the channel assets by moderator
--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/deleteChannelAssetsAsModerator.ts
joystream-cli content:deleteVideoDelete 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|Curator|Collaborator) Actor context to execute the command in (Owner/Curator/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:deleteVideoAssetsAsModeratorDelete the video assets.
USAGE
$ joystream-cli content:deleteVideoAssetsAsModerator
OPTIONS
-a, --assetIds=assetIds (required) List of data object IDs to delete
-r, --rationale=rationale (required) Reason for removing the video assets by moderator
-v, --videoId=videoId (required) ID of the Video
--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/deleteVideoAssetsAsModerator.ts
joystream-cli content:directChannelPaymentMake direct payment to channel's reward account by any member .
USAGE
$ joystream-cli content:directChannelPayment
OPTIONS
-r, --rationale=rationale (required) Reason for the payment
-v, --videoId=videoId video ID for which payment is being made. If not provided, payment is supposed to be a
channel wide tip
--amount=amount (required) JOY amount to be paid
--channelId=channelId ID of the channel to be paid
--rewardAccount=rewardAccount Reward account of the channel to be paid
--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/directChannelPayment.ts
joystream-cli content:generateChannelPayoutsCommitmentGenerate merkle root (commitment) from channel payouts payload.
USAGE
$ joystream-cli content:generateChannelPayoutsCommitment
OPTIONS
--path=path Path to the serialized payload file
--url=url URL to the serialized payload file
--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/generateChannelPayoutsCommitment.ts
joystream-cli content:generateChannelPayoutsPayloadGenerate serialized channel payouts payload from JSON input.
USAGE
$ joystream-cli content:generateChannelPayoutsPayload
OPTIONS
-i, --input=input (required) Path to JSON file containing channel payouts vector
-o, --out=out (required) Path to output file where serialized channel payouts payload will be saved
--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/generateChannelPayoutsPayload.ts
joystream-cli content:getPayoutsOnchainCommitmentGet on-chain commitment (merkle root) for channel payouts payload.
USAGE
$ joystream-cli content:getPayoutsOnchainCommitment
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/getPayoutsOnchainCommitment.ts
joystream-cli content:removeChannelAssetsRemove 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|Curator|Collaborator) Actor context to execute the command in (Owner/Curator/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:reuploadAssetsAllows 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:setChannelVisibilityAsModeratorSet channel visibility as moderator.
USAGE
$ joystream-cli content:setChannelVisibilityAsModerator
OPTIONS
-c, --channelId=channelId (required) ID of the channel
-r, --rationale=rationale (required) Reason for changing visibility of channel
-s, --status=(VISIBLE|HIDDEN) (required) The visibility status of the channel
--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/setChannelVisibilityAsModerator.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:setVideoVisibilityAsModeratorSet video visibility as moderator.
USAGE
$ joystream-cli content:setVideoVisibilityAsModerator
OPTIONS
-r, --rationale=rationale (required) Reason for changing visibility of video
-s, --status=(VISIBLE|HIDDEN) (required) The visibility status of the video
-v, --videoId=videoId (required) ID of the Video
--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/setVideoVisibilityAsModerator.ts
joystream-cli content:updateChannel CHANNELIDUpdate 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|Curator|Collaborator) Actor context to execute the command in (Owner/Curator/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:updateChannelPayoutsProposalCreate channel payouts proposal.
USAGE
$ joystream-cli content:updateChannelPayoutsProposal
OPTIONS
-b, --exactExecutionBlock=exactExecutionBlock The Block at which the proposal should be automatically executed
-d, --description=description (required) Description of the proposal
-e, --channelCashoutsEnabled Whether cashouts be enabled/disabled
-p, --payloadFilePath=payloadFilePath Path to protobuf serialized file containing channel payouts payload
-s, --stakingAccountId=stakingAccountId (required) Proposer staking account Id
-t, --title=title (required) Title of the proposal
--max=max Maximum cashout amount allowed to a channel
--min=min Minimum cashout amount allowed to a channel
--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/updateChannelPayoutsProposal.ts
joystream-cli content:updateChannelStateBloatBond VALUEUpdate channel state bloat bond.
USAGE
$ joystream-cli content:updateChannelStateBloatBond VALUE
ARGUMENTS
VALUE New state bloat bond value
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/updateChannelStateBloatBond.ts
joystream-cli content:updateCuratorGroupPermissions [ID]Update existing Curator Group.
USAGE
$ joystream-cli content:updateCuratorGroupPermissions [ID]
ARGUMENTS
ID ID of the Curator Group
OPTIONS
-p, --permissions=permissions (required) Path to JSON file containing moderation permissions by channel privilege
level 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/content/updateCuratorGroupPermissions.ts
joystream-cli content:updateVideo VIDEOIDUpdate 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|Curator|Collaborator) Actor context to execute the command in (Owner/Curator/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:updateVideoStateBloatBond VALUEUpdate video state bloat bond.
USAGE
$ joystream-cli content:updateVideoStateBloatBond VALUE
ARGUMENTS
VALUE New state bloat bond value
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/updateVideoStateBloatBond.ts
joystream-cli content:video VIDEOIDShow 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 council:fundBudgetFund council budget by some member.
USAGE
$ joystream-cli council:fundBudget
OPTIONS
--amount=amount (required) Funding amount
--rationale=rationale (required) Reason of funding the budget
--useMemberId=useMemberId Try using the specified member id as context whenever possible
See code: src/commands/council/fundBudget.ts
joystream-cli fee-profile:addForumPostCreate fee profile of forum.add_post extrinsic.
USAGE
$ joystream-cli fee-profile:addForumPost
OPTIONS
-e, --editable If specified - `editable` parameter is set to true when estimating the costs
-j, --joyPrice=joyPrice [default: 6] Joy price in USD cents for estimating costs in USD
-p, --postLen=postLen [default: 200] Post length to use for estimating tx fee
See code: src/commands/fee-profile/addForumPost.ts
joystream-cli fee-profile:addVideoCommentCreate fee profile of members.member_remark extrinsic (video comment case).
USAGE
$ joystream-cli fee-profile:addVideoComment
OPTIONS
-c, --commentLen=commentLen [default: 50] Comment length to use for estimating tx fee
-j, --joyPrice=joyPrice [default: 6] Joy price in USD cents for estimating costs in USD
See code: src/commands/fee-profile/addVideoComment.ts
joystream-cli fee-profile:buyMembershipCreate fee profile of members.buy_membership extrinsic.
USAGE
$ joystream-cli fee-profile:buyMembership
OPTIONS
-E, --externalResourcesCount=externalResourcesCount [default: 1] Number of external resources (part of metadata) to
use for estimating tx fee
-a, --aboutLength=aboutLength [default: 0] Length of the member's about text (part of metadata)
to use for estimating tx fee
-e, --externalResourceLength=externalResourceLength [default: 25] Length of a single external resource url (part of
metadata) to use for estimating tx fee
-h, --handleLength=handleLength [default: 10] Length of the membership handle to use for
estimating tx fee
-j, --joyPrice=joyPrice [default: 6] Joy price in USD cents for estimating costs in USD
-n, --nameLength=nameLength [default: 10] Length of the member's name (part of metadata) to
use for estimating tx fee
-u, --avatarUriLength=avatarUriLength [default: 25] Length of the member's avatar uri (part of
metadata) to use for estimating tx fee
See code: src/commands/fee-profile/buyMembership.ts
joystream-cli fee-profile:createChannelCreate fee profile of content.create_channel extrinsic.
USAGE
$ joystream-cli fee-profile:createChannel
OPTIONS
-C, --collaboratorsNum=collaboratorsNum [default: 0] Number of channel collaborators to use for
estimating tx fee
-D, --distributionBucketsNum=distributionBucketsNum Number of distribution buckets to use for estimating tx fee.
By default this number will be based on the current chain's
dynamic bag policy for channel bags
-S, --storageBucketsNum=storageBucketsNum Number of storage buckets to use for estimating tx fee.
By default this number will be based on the current chain's
dynamic bag policy for channel bags
-a, --avatarSize=avatarSize [default: 1] Avatar size in MB to use when estimating the costs
-c, --coverSize=coverSize [default: 1] Cover photo size in MB to use when estimating the
costs
-d, --descriptionLen=descriptionLen [default: 200] Channel description (part of channel metadata)
length to use for estimating tx fee
-j, --joyPrice=joyPrice [default: 6] Joy price in USD cents for estimating costs in USD
-t, --titleLen=titleLen [default: 15] Channel title (part of channel metadata) length to
use for estimating tx fee
--noAvatar If provided - channel with no avatar will be used for estimating
the costs
--noCover If provided - channel with no cover photo will be used for
estimating the costs
See code: src/commands/fee-profile/createChannel.ts
joystream-cli fee-profile:createForumThreadCreate fee profile of forum.create_thread extrinsic.
USAGE
$ joystream-cli fee-profile:createForumThread
OPTIONS
-G, --tagsNum=tagsNum [default: 5] Number of forum thread tags (part of thread metadata) to use for
estimating tx fee
-g, --tagLen=tagLen [default: 10] Single tag length (part of thread metadata) to use for estimating
tx fee
-j, --joyPrice=joyPrice [default: 6] Joy price in USD cents for estimating costs in USD
-p, --initialPostLen=initialPostLen [default: 200] Thread's initial post length to use for estimating tx fee
-t, --titleLen=titleLen [default: 20] Thread title (part of thread metadata) length to use for estimating
tx fee
See code: src/commands/fee-profile/createForumThread.ts
joystream-cli fee-profile:createVideoCreate fee profile of content.create_video extrinsic.
USAGE
$ joystream-cli fee-profile:createVideo
OPTIONS
-S, --storageBucketsNum=storageBucketsNum Number of storage buckets to use for estimating tx fee.
By default this number will be based on the current chain's
dynamic bag policy for channel bags
-T, --thumbnailSize=thumbnailSize [default: 1] Thumbnail photo size in MB to use for estimating
the costs
-c, --categoryLen=categoryLen [default: 10] Video cateogry (part of video metadata) length to
use for estimating tx fee
-d, --descriptionLen=descriptionLen [default: 200] Video description (part of video metadata)
length to use for estimating tx fee
-f, --subtitlesFileSize=subtitlesFileSize [default: 1] Single subtitles file/asset size in MB to use for
estimating the costs
-j, --joyPrice=joyPrice [default: 6] Joy price in USD cents for estimating costs in USD
-m, --mediaSize=mediaSize [default: 200] Video media file size in MB to use for
estimating the costs
-s, --subtitlesNum=subtitlesNum [default: 1] Number of subtitles (subtitle assets) to use for
estimating the costs
-t, --titleLen=titleLen [default: 15] Video title (part of video metadata) length to
use for estimating tx fee
-w, --nftAuctionWhitelistSize=nftAuctionWhitelistSize If `--withNft` is provided - determines auction whitelist size
in nft's InitTransactionalStatus to use when estimating tx fee
(Default: 0)
--noMedia If provided - video with no media asset will be used for
estimating the costs
--noThumbnail If provided - video with no thumbnail asset will be used for
estimating the costs
--withNft If provided - `auto_issue_nft` parameter will be set when
estimating tx fee
See code: src/commands/fee-profile/createVideo.ts
joystream-cli fee-profile:deleteChannelCreate fee profile of content.delete_channel extrinsic.
USAGE
$ joystream-cli fee-profile:deleteChannel
OPTIONS
-D, --distributionBucketsNum=distributionBucketsNum Number of distribution buckets to use for estimating tx fee.
By default this number will be based on the current chain's
dynamic bag policy for channel bags
-S, --storageBucketsNum=storageBucketsNum Number of storage buckets to use for estimating tx fee.
By default this number will be based on the current chain's
dynamic bag policy for channel bags
-a, --assetsNum=assetsNum [default: 2] Number of assets to use for estimating the
costs/returns
-j, --joyPrice=joyPrice [default: 6] Joy price in USD cents for estimating costs in USD
See code: src/commands/fee-profile/deleteChannel.ts
joystream-cli fee-profile:deleteForumPostCreate fee profile of forum.delete_posts extrinsic (single post case).
USAGE
$ joystream-cli fee-profile:deleteForumPost
OPTIONS
-j, --joyPrice=joyPrice [default: 6] Joy price in USD cents for estimating costs in USD
-r, --rationaleLen=rationaleLen [default: 0] Default rationale length to use for estimating tx fee
See code: src/commands/fee-profile/deleteForumPost.ts
joystream-cli fee-profile:deleteForumThreadCreate fee profile of forum.delete_thread extrinsic.
USAGE
$ joystream-cli fee-profile:deleteForumThread
OPTIONS
-j, --joyPrice=joyPrice [default: 6] Joy price in USD cents for estimating costs in USD
See code: src/commands/fee-profile/deleteForumThread.ts
joystream-cli fee-profile:deleteVideoCreate fee profile of forum.delete_video extrinsic.
USAGE
$ joystream-cli fee-profile:deleteVideo
OPTIONS
-S, --storageBucketsNum=storageBucketsNum Number of storage buckets to use for estimating tx fee.
By default this number will be based on the current chain's dynamic bag
policy for channel bags
-a, --assetsNum=assetsNum [default: 2] Number of assets to use for estimating the costs/returns
-j, --joyPrice=joyPrice [default: 6] Joy price in USD cents for estimating costs in USD
See code: src/commands/fee-profile/deleteVideo.ts
joystream-cli forum:addPostAdd 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:categoriesList 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:categoryDisplay 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:createCategoryCreate 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:createThreadCreate 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:deleteCategoryDelete 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:moderatePostModerate 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:moderateThreadModerate 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:moveThreadMove 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:postsList 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:setStickiedThreadsSet 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:threadsList 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:updateCategoryArchivalStatusUpdate 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:updateCategoryModeratorStatusUpdate 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:addStakingAccountAssociate 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:buyBuy / 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:detailsDisplay 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:memberRemark MESSAGEMember remarks
USAGE
$ joystream-cli membership:memberRemark MESSAGE
ARGUMENTS
MESSAGE Remark message
OPTIONS
--account=account Account where JOY needs to be transferred
--amount=amount JOY amount to be transferred
--useMemberId=useMemberId Try using the specified member id as context whenever possible
See code: src/commands/membership/memberRemark.ts
joystream-cli membership:updateUpdate 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:updateAccountsUpdate 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 sign-offline:signUnsignedTxSign an unsigned transaction. Does not require an api connection.
USAGE
$ joystream-cli sign-offline:signUnsignedTx
OPTIONS
-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 JSON with full transaction details should be
saved.If omitted, only the signed transaction, the signature and the tx hash is
included
--backupFilePath=backupFilePath Path to account backup JSON file
--keypairType=(sr25519|ed25519|ecdsa) [default: sr25519] Account type (defaults to sr25519)
--mnemonic=mnemonic Mnemonic phrase
--password=password Account password
--seed=seed Secret seed
--suri=suri Substrate uri
See code: src/commands/sign-offline/signUnsignedTx.ts
joystream-cli staking:validateStart 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 util:decodeMessageDecode a protobuf message (from hex to json)
USAGE
$ joystream-cli util:decodeMessage
OPTIONS
--hex=hex
(required) Hex-encoded protobuf message'
--type=(AppActionMetadata|AppAction|BountyMetadata|BountyWorkData|ChannelMetadata|ChannelPayoutsMetadata|CouncilCandid
acyNoteMetadata|ForumPostMetadata|ForumThreadMetadata|MembershipMetadata|ReactVideo|ReactComment|CreateComment|EditCom
ment|DeleteComment|PinOrUnpinComment|ModerateComment|BanOrUnbanMemberFromChannel|VideoReactionsPreference|CreateVideoC
ategory|MakeChannelPayment|AppMetadata|CreateApp|UpdateApp|MemberRemarked|ChannelModeratorRemarked|ChannelOwnerRemarke
d|PersonMetadata|ProposalsDiscussionPostMetadata|SeriesMetadata|SeasonMetadata|GeoCoordiantes|NodeLocationMetadata|Sto
rageBucketOperatorMetadata|DistributionBucketOperatorMetadata|GeographicalArea|DistributionBucketFamilyMetadata|Creato
rTokenIssuerRemarked|UpdateTokenMetadata|TokenMetadata|Benefit|SaleMetadata|PublishedBeforeJoystream|License|MediaType
|SubtitleMetadata|VideoMetadata|ContentMetadata|OpeningMetadata|UpcomingOpeningMetadata|ApplicationMetadata|WorkingGro
upMetadata|SetGroupMetadata|AddUpcomingOpening|RemoveUpcomingOpening|WorkingGroupMetadataAction|ModeratePost|RemarkMet
adataAction|VerifyValidator)
Type of the message
See code: src/commands/util/decodeMessage.ts
joystream-cli util:encodeMessageEncode a protobuf message (from json to hex)
USAGE
$ joystream-cli util:encodeMessage
OPTIONS
-i, --input=input
Path to a file containing a JSON-encoded message
--jsonString=jsonString
JSON-encoded message input (eg. '{"videoId":1}'
--type=(AppActionMetadata|AppAction|BountyMetadata|BountyWorkData|ChannelMetadata|ChannelPayoutsMetadata|CouncilCandid
acyNoteMetadata|ForumPostMetadata|ForumThreadMetadata|MembershipMetadata|ReactVideo|ReactComment|CreateComment|EditCom
ment|DeleteComment|PinOrUnpinComment|ModerateComment|BanOrUnbanMemberFromChannel|VideoReactionsPreference|CreateVideoC
ategory|MakeChannelPayment|AppMetadata|CreateApp|UpdateApp|MemberRemarked|ChannelModeratorRemarked|ChannelOwnerRemarke
d|PersonMetadata|ProposalsDiscussionPostMetadata|SeriesMetadata|SeasonMetadata|GeoCoordiantes|NodeLocationMetadata|Sto
rageBucketOperatorMetadata|DistributionBucketOperatorMetadata|GeographicalArea|DistributionBucketFamilyMetadata|Creato
rTokenIssuerRemarked|UpdateTokenMetadata|TokenMetadata|Benefit|SaleMetadata|PublishedBeforeJoystream|License|MediaType
|SubtitleMetadata|VideoMetadata|ContentMetadata|OpeningMetadata|UpcomingOpeningMetadata|ApplicationMetadata|WorkingGro
upMetadata|SetGroupMetadata|AddUpcomingOpening|RemoveUpcomingOpening|WorkingGroupMetadataAction|ModeratePost|RemarkMet
adataAction|VerifyValidator)
Type of the message
See code: src/commands/util/encodeMessage.ts
joystream-cli util:messageStructureShow message structure (available fields, their types and indexes)
USAGE
$ joystream-cli util:messageStructure
OPTIONS
--type=(AppActionMetadata|AppAction|BountyMetadata|BountyWorkData|ChannelMetadata|ChannelPayoutsMetadata|CouncilCandid
acyNoteMetadata|ForumPostMetadata|ForumThreadMetadata|MembershipMetadata|ReactVideo|ReactComment|CreateComment|EditCom
ment|DeleteComment|PinOrUnpinComment|ModerateComment|BanOrUnbanMemberFromChannel|VideoReactionsPreference|CreateVideoC
ategory|MakeChannelPayment|AppMetadata|CreateApp|UpdateApp|MemberRemarked|ChannelModeratorRemarked|ChannelOwnerRemarke
d|PersonMetadata|ProposalsDiscussionPostMetadata|SeriesMetadata|SeasonMetadata|GeoCoordiantes|NodeLocationMetadata|Sto
rageBucketOperatorMetadata|DistributionBucketOperatorMetadata|GeographicalArea|DistributionBucketFamilyMetadata|Creato
rTokenIssuerRemarked|UpdateTokenMetadata|TokenMetadata|Benefit|SaleMetadata|PublishedBeforeJoystream|License|MediaType
|SubtitleMetadata|VideoMetadata|ContentMetadata|OpeningMetadata|UpcomingOpeningMetadata|ApplicationMetadata|WorkingGro
upMetadata|SetGroupMetadata|AddUpcomingOpening|RemoveUpcomingOpening|WorkingGroupMetadataAction|ModeratePost|RemarkMet
adataAction|VerifyValidator)
Type of the message
See code: src/commands/util/messageStructure.ts
joystream-cli working-groups:application WGAPPLICATIONIDShows 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|app|builders|humanResources|marketing|distributors)
The working group context in which the command should be executed
Available values are: storageProviders, curators, forum, membership, app, 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:applyApply to a working group opening (requires a membership)
USAGE
$ joystream-cli working-groups:apply
OPTIONS
-g, --group=(storageProviders|curators|forum|membership|app|builders|humanResources|marketing|distributors)
The working group context in which the command should be executed
Available values are: storageProviders, curators, forum, membership, app, 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 OPENINGIDCancels (removes) an active opening
USAGE
$ joystream-cli working-groups:cancelOpening OPENINGID
ARGUMENTS
OPENINGID Opening ID
OPTIONS
-g, --group=(storageProviders|curators|forum|membership|app|builders|humanResources|marketing|distributors)
The working group context in which the command should be executed
Available values are: storageProviders, curators, forum, membership, app, 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:createOpeningCreate 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|app|builders|humanResources|marketing|distributors)
The working group context in which the command should be executed
Available values are: storageProviders, curators, forum, membership, app, 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 AMOUNTDecreases 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|app|builders|humanResources|marketing|distributors)
The working group context in which the command should be executed
Available values are: storageProviders, curators, forum, membership, app, 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 WORKERIDEvicts given worker. Requires lead access.
USAGE
$ joystream-cli working-groups:evictWorker WORKERID
ARGUMENTS
WORKERID Worker ID
OPTIONS
-g, --group=(storageProviders|curators|forum|membership|app|builders|humanResources|marketing|distributors)
The working group context in which the command should be executed
Available values are: storageProviders, curators, forum, membership, app, 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:fillOpeningAllows 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|app|builders|humanResources|marketing|distributors)
The working group context in which the command should be executed
Available values are: storageProviders, curators, forum, membership, app, 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 AMOUNTIncreases 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|app|builders|humanResources|marketing|distributors)
The working group context in which the command should be executed
Available values are: storageProviders, curators, forum, membership, app, 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:leaveRoleLeave the worker or lead role associated with currently selected account.
USAGE
$ joystream-cli working-groups:leaveRole
OPTIONS
-g, --group=(storageProviders|curators|forum|membership|app|builders|humanResources|marketing|distributors)
The working group context in which the command should be executed
Available values are: storageProviders, curators, forum, membership, app, 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:openingShows detailed information about working group opening / upcoming opening by id
USAGE
$ joystream-cli working-groups:opening
OPTIONS
-g, --group=(storageProviders|curators|forum|membership|app|builders|humanResources|marketing|distributors)
The working group context in which the command should be executed
Available values are: storageProviders, curators, forum, membership, app, 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:openingsLists active/upcoming openings in a given working group
USAGE
$ joystream-cli working-groups:openings
OPTIONS
-g, --group=(storageProviders|curators|forum|membership|app|builders|humanResources|marketing|distributors)
The working group context in which the command should be executed
Available values are: storageProviders, curators, forum, membership, app, 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:overviewShows an overview of given working group (current lead and workers)
USAGE
$ joystream-cli working-groups:overview
OPTIONS
-g, --group=(storageProviders|curators|forum|membership|app|builders|humanResources|marketing|distributors)
The working group context in which the command should be executed
Available values are: storageProviders, curators, forum, membership, app, 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:removeUpcomingOpeningRemove 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|app|builders|humanResources|marketing|distributors)
The working group context in which the command should be executed
Available values are: storageProviders, curators, forum, membership, app, 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:setDefaultGroupChange the default group context for working-groups commands.
USAGE
$ joystream-cli working-groups:setDefaultGroup
OPTIONS
-g, --group=(storageProviders|curators|forum|membership|app|builders|humanResources|marketing|distributors)
The working group context in which the command should be executed
Available values are: storageProviders, curators, forum, membership, app, 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 AMOUNTSlashes 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|app|builders|humanResources|marketing|distributors)
The working group context in which the command should be executed
Available values are: storageProviders, curators, forum, membership, app, 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:updateGroupMetadataUpdate 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|app|builders|humanResources|marketing|distributors)
The working group context in which the command should be executed
Available values are: storageProviders, curators, forum, membership, app, 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|app|builders|humanResources|marketing|distributors)
The working group context in which the command should be executed
Available values are: storageProviders, curators, forum, membership, app, 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|app|builders|humanResources|marketing|distributors)
The working group context in which the command should be executed
Available values are: storageProviders, curators, forum, membership, app, 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:updateWorkerReward WORKERID NEWREWARDChange 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|app|builders|humanResources|marketing|distributors)
The working group context in which the command should be executed
Available values are: storageProviders, curators, forum, membership, app, 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/updateWorkerReward.ts
joystream-cli working-groups:verifyValidator MEMBERIDVerify or un-verify the membership profile bound to a validator account. Available to membership workers only.
USAGE
$ joystream-cli working-groups:verifyValidator MEMBERID
ARGUMENTS
MEMBERID ID of the membership bound to the validator account.
OPTIONS
-g, --group=(storageProviders|curators|forum|membership|app|builders|humanResources|marketing|distributors)
The working group context in which the command should be executed
Available values are: storageProviders, curators, forum, membership, app, builders, humanResources, marketing,
distributors.
--unverify
Whether the profile should be un-verified.
--useMemberId=useMemberId
Try using the specified member id as context whenever possible
--useWorkerId=useWorkerId
Try using the specified worker id as context whenever possible
FAQs
Command Line Interface for Joystream community and governance activities
The npm package @joystream/cli receives a total of 88 weekly downloads. As such, @joystream/cli popularity was classified as not popular.
We found that @joystream/cli demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
In this segment of the Risky Business podcast, Feross Aboukhadijeh and Patrick Gray discuss the challenges of tracking malware discovered in open source softare.
Research
Security News
A threat actor's playbook for exploiting the npm ecosystem was exposed on the dark web, detailing how to build a blockchain-powered botnet.
Security News
NVD’s backlog surpasses 20,000 CVEs as analysis slows and NIST announces new system updates to address ongoing delays.