@niftory/cli NPM

Niftory CLI logo

:exclamation: This package is in active development and is not ready for widespread use.

Niftory CLI

CLI for the Niftory platform.

Usage

$ npm install -g @niftory/cli
$ niftory COMMAND
running command...
$ niftory (--version)
@niftory/cli/0.1.1-alpha.0 linux-x64 node-v18.13.0
$ niftory --help [COMMAND]
USAGE
  $ niftory COMMAND
...

Commands

`niftory app select`

Select app an app from the currently authenticated ones.

USAGE
  $ niftory app select [--appId <value> --environment testnet|mainnet] [--appName <value> ]

FLAGS
  --appId=<value>                  The app ID to run the command in the context of. If not specified, defaults to the
                                   app specified at login.
  --appName=<value>                The app name to run the command in the context of. If not specified, defaults to the
                                   app specified at login.
  --environment=(testnet|mainnet)  The environment to run the command in the context of. If not specified, defaults to
                                   the environment of the app specified at login.

DESCRIPTION
  Select app an app from the currently authenticated ones.

EXAMPLES
  $ niftory app select

`niftory autocomplete [SHELL]`

display autocomplete installation instructions

USAGE
  $ niftory autocomplete [SHELL] [-r]

ARGUMENTS
  SHELL  shell type

FLAGS
  -r, --refresh-cache  Refresh cache (ignores displaying instructions)

DESCRIPTION
  display autocomplete installation instructions

EXAMPLES
  $ niftory autocomplete

  $ niftory autocomplete bash

  $ niftory autocomplete zsh

  $ niftory autocomplete --refresh-cache

See code: @oclif/plugin-autocomplete

`niftory file get ID`

Gets a file by ID

USAGE
  $ niftory file get [ID] [--appId <value> --environment testnet|mainnet] [--appName <value> ]

ARGUMENTS
  ID  The file to fetch

FLAGS
  --appId=<value>                  The app ID to run the command in the context of. If not specified, defaults to the
                                   app specified at login.
  --appName=<value>                The app name to run the command in the context of. If not specified, defaults to the
                                   app specified at login.
  --environment=(testnet|mainnet)  The environment to run the command in the context of. If not specified, defaults to
                                   the environment of the app specified at login.

DESCRIPTION
  Gets a file by ID

EXAMPLES
  $ niftory file get <id>

`niftory file upload PATH [DESCRIPTION]`

Uploads a file

USAGE
  $ niftory file upload [PATH] [DESCRIPTION] [--appId <value> --environment testnet|mainnet] [--appName <value> ]
    [--name <value>]

ARGUMENTS
  PATH         The path of the file to upload
  DESCRIPTION  A description for the file.

FLAGS
  --appId=<value>                  The app ID to run the command in the context of. If not specified, defaults to the
                                   app specified at login.
  --appName=<value>                The app name to run the command in the context of. If not specified, defaults to the
                                   app specified at login.
  --environment=(testnet|mainnet)  The environment to run the command in the context of. If not specified, defaults to
                                   the environment of the app specified at login.
  --name=<value>                   The name of the file to upload. Defaults to its name on disk

DESCRIPTION
  Uploads a file

EXAMPLES
  $ niftory file upload <path>

`niftory help [COMMAND]`

Display help for niftory.

USAGE
  $ niftory help [COMMAND] [-n]

ARGUMENTS
  COMMAND  Command to show help for.

FLAGS
  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION
  Display help for niftory.

See code: @oclif/plugin-help

`niftory login`

Log into the Niftory CLI.

USAGE
  $ niftory login [--environment testnet|mainnet]

FLAGS
  --environment=<option>  <options: testnet|mainnet>

DESCRIPTION
  Log into the Niftory CLI.

EXAMPLES
  $ niftory login

See code: dist/commands/login.ts

`niftory nft get ID`

Gets an NFT by ID

USAGE
  $ niftory nft get [ID] [--appId <value> --environment testnet|mainnet] [--appName <value> ]

ARGUMENTS
  ID  The NFT to fetch

FLAGS
  --appId=<value>                  The app ID to run the command in the context of. If not specified, defaults to the
                                   app specified at login.
  --appName=<value>                The app name to run the command in the context of. If not specified, defaults to the
                                   app specified at login.
  --environment=(testnet|mainnet)  The environment to run the command in the context of. If not specified, defaults to
                                   the environment of the app specified at login.

DESCRIPTION
  Gets an NFT by ID

EXAMPLES
  $ niftory nft get <id>

`niftory nft transfer`

Transfers an NFT to another address, user or wallet. This mutation requires the userId, walletId' or the walletaddress` to be specified

USAGE
  $ niftory nft transfer [--appId <value> --environment testnet|mainnet] [--appName <value> ] [--id <value> |
    --nftModelId <value>] [--userId <value> | --walletId <value> | --address <value>] [--wait]

FLAGS
  --address=<value>                The address of the Wallet to to transfer the NFT. This mutation requires the
                                   `userId`, `walletId' or the wallet `address` to be specified.
  --appId=<value>                  The app ID to run the command in the context of. If not specified, defaults to the
                                   app specified at login.
  --appName=<value>                The app name to run the command in the context of. If not specified, defaults to the
                                   app specified at login.
  --environment=(testnet|mainnet)  The environment to run the command in the context of. If not specified, defaults to
                                   the environment of the app specified at login.
  --id=<value>                     The ID of the NFT to transfer. Only one of id or nftModelId can be used.
  --nftModelId=<value>             The nftModel to randomly select an NFT from. Only one of id or nftModelId can be
                                   used.
  --userId=<value>                 The ID of the AppUser to send the NFT to. This mutation requires the `userId`,
                                   `walletId' or the wallet `address` to be specified.
  --wait                           Wait until the NFT transfer is complete before returning.
  --walletId=<value>               The database ID of the Wallet to send the NFT to. This mutation requires the
                                   `userId`, `walletId' or the wallet `address` to be specified.

DESCRIPTION
  Transfers an NFT to another address, user or wallet. This mutation requires the `userId`, `walletId' or the wallet
  `address` to be specified

EXAMPLES
  $ niftory nft transfer --id <id> --nftModelId <nftModelId> --userId <userId> --walletId <walletId> --address <address>

`niftory nft withdraw`

Withdraws an NFT to from user custodial wallet to another wallet. This mutation requires the NFT id, niftoryWalletAddress and receiverAddress to be specified

USAGE
  $ niftory nft withdraw --id <value> --receiverAddress <value> --niftoryWalletAddress <value> [--appId <value>
    --environment testnet|mainnet] [--appName <value> ]

FLAGS
  --appId=<value>                  The app ID to run the command in the context of. If not specified, defaults to the
                                   app specified at login.
  --appName=<value>                The app name to run the command in the context of. If not specified, defaults to the
                                   app specified at login.
  --environment=(testnet|mainnet)  The environment to run the command in the context of. If not specified, defaults to
                                   the environment of the app specified at login.
  --id=<value>                     (required) The ID of the NFT to withdraw. The NFT needs to belong to a custodial
                                   wallet
  --niftoryWalletAddress=<value>   (required) The address of the niftory custodial wallet to withdraw the NFT from.
  --receiverAddress=<value>        (required) The address of the external wallet to withdraw the NFT.

DESCRIPTION
  Withdraws an NFT to from user custodial wallet to another wallet. This mutation requires the NFT `id`,
  `niftoryWalletAddress` and  `receiverAddress` to be specified

EXAMPLES
  $ niftory nft withdraw --id <id> --niftoryWalletAddress <niftoryWalletAddress> --receiverAddress <receiverAddress>

`niftory nftmodel create`

Creates a new NFTModel

USAGE
  $ niftory nftmodel create [--appId <value> --environment testnet|mainnet] [--appName <value> ] [-t <value>]

FLAGS
  -t, --tag=<value>...             String labels to tag this NFTModel with. These will be stored in the Niftory API but
                                   will not be added to the blockchain
  --appId=<value>                  The app ID to run the command in the context of. If not specified, defaults to the
                                   app specified at login.
  --appName=<value>                The app name to run the command in the context of. If not specified, defaults to the
                                   app specified at login.
  --environment=(testnet|mainnet)  The environment to run the command in the context of. If not specified, defaults to
                                   the environment of the app specified at login.

DESCRIPTION
  Creates a new NFTModel

EXAMPLES
  $ niftory nftModel create --tag <tag1>  --tag <tag2>

`niftory nftmodel get ID`

Gets an NFT Model by ID

USAGE
  $ niftory nftmodel get [ID] [--appId <value> --environment testnet|mainnet] [--appName <value> ]

ARGUMENTS
  ID  The nft model to fetch

FLAGS
  --appId=<value>                  The app ID to run the command in the context of. If not specified, defaults to the
                                   app specified at login.
  --appName=<value>                The app name to run the command in the context of. If not specified, defaults to the
                                   app specified at login.
  --environment=(testnet|mainnet)  The environment to run the command in the context of. If not specified, defaults to
                                   the environment of the app specified at login.

DESCRIPTION
  Gets an NFT Model by ID

EXAMPLES
  $ niftory nftmodel get <id>

`niftory nftmodel mint NFTMODELID`

Initiates minting for a given NFTModel

USAGE
  $ niftory nftmodel mint [NFTMODELID] [--appId <value> --environment testnet|mainnet] [--appName <value> ]
    [--quantity <value>] [--wait]

ARGUMENTS
  NFTMODELID  The NFT Model to mint

FLAGS
  --appId=<value>                  The app ID to run the command in the context of. If not specified, defaults to the
                                   app specified at login.
  --appName=<value>                The app name to run the command in the context of. If not specified, defaults to the
                                   app specified at login.
  --environment=(testnet|mainnet)  The environment to run the command in the context of. If not specified, defaults to
                                   the environment of the app specified at login.
  --quantity=<value>               The number of NFTs to mint. Defaults to minting all NFTs in the model. If quantity
                                   exceeds the quantity defined in the model, the latter is used.
  --wait                           Wait until the NFTs are minted before returning.

DESCRIPTION
  Initiates minting for a given NFTModel

EXAMPLES
  $ niftory nftModel mint <nftModelId> --quantity <quantity>

`niftory set create TITLE`

Created a new set

USAGE
  $ niftory set create [TITLE] [--appId <value> --environment testnet|mainnet] [--appName <value> ] [-t <value>]

ARGUMENTS
  TITLE  The title of the new set

FLAGS
  -t, --tags=<value>...            String labels to tag this Set with. These will be stored in the Niftory API but will
                                   not be added to the blockchain
  --appId=<value>                  The app ID to run the command in the context of. If not specified, defaults to the
                                   app specified at login.
  --appName=<value>                The app name to run the command in the context of. If not specified, defaults to the
                                   app specified at login.
  --environment=(testnet|mainnet)  The environment to run the command in the context of. If not specified, defaults to
                                   the environment of the app specified at login.

DESCRIPTION
  Created a new set

EXAMPLES
  $ niftory set create <title> --tags <tag1> <tag2>

`niftory set get ID`

Gets a set by ID

USAGE
  $ niftory set get [ID] [--appId <value> --environment testnet|mainnet] [--appName <value> ]

ARGUMENTS
  ID  The set to fetch

FLAGS
  --appId=<value>                  The app ID to run the command in the context of. If not specified, defaults to the
                                   app specified at login.
  --appName=<value>                The app name to run the command in the context of. If not specified, defaults to the
                                   app specified at login.
  --environment=(testnet|mainnet)  The environment to run the command in the context of. If not specified, defaults to
                                   the environment of the app specified at login.

DESCRIPTION
  Gets a set by ID

EXAMPLES
  $ niftory set get <id>

`niftory whoami`

USAGE
  $ niftory whoami [--appId <value> --environment testnet|mainnet] [--appName <value> ]

FLAGS
  --appId=<value>                  The app ID to run the command in the context of. If not specified, defaults to the
                                   app specified at login.
  --appName=<value>                The app name to run the command in the context of. If not specified, defaults to the
                                   app specified at login.
  --environment=(testnet|mainnet)  The environment to run the command in the context of. If not specified, defaults to
                                   the environment of the app specified at login.

See code: dist/commands/whoami/index.ts

oclif