Back to Sui

Sui Move Help

docs/content/snippets/console-output/sui-move-help.mdx

latest3.0 KB
Original Source
sh
Tool to build and test Move applications

Usage: sui move [OPTIONS] <COMMAND>

Commands:
  build        
  coverage     Inspect test coverage for this package. A previous test run with the `--coverage`
                   flag must have previously been run
  disassemble  
  migrate      Migrate to Move 2024 for the package at `path`. If no path is provided defaults
                   to current directory
  new          Create a new Move package with name `name` at `path`. If `path` is not provided
                   the package will be created in the directory `name`
  test         Run Move unit tests in this package
  summary      Generate a serialized summary of a Move package (e.g., functions, structs,
                   annotations, etc.)
  update-deps  Re-pin the dependencies of this package
  help         Print this message or the help of the given subcommand(s)

Options:
  -p, --path <PACKAGE_PATH>
          Path to a package which the command should be run with respect to
      --client.config <CONFIG>
          Sets the file storing the state of our user accounts (an empty one will be created if
          missing)
      --client.env <ENV>
          The Sui environment to use. This must be present in the current config file
  -y, --yes
          Create a new sui config without prompting if none exists
      --test
          Compile in 'test' mode and include the code in the 'tests' directory
      --doc
          Generate documentation for packages
      --disassemble
          Save disassembly for generated bytecode along with bytecode maps (source maps for
          disassembled bytecode)
      --install-dir <INSTALL_DIR>
          Installation directory for compiled artifacts. Defaults to current directory
      --force
          Force recompilation of all packages
      --allow-dirty
          Allow building, even if some cached git dependencies in `~/.move` are modified
      --default-move-flavor <DEFAULT_FLAVOR>
          Default flavor for move compilation, if not specified in the package's config
      --default-move-edition <DEFAULT_EDITION>
          Default edition for move compilation, if not specified in the package's config
      --silence-warnings
          If set, ignore any compiler warnings
      --warnings-are-errors
          If set, warnings become errors
      --json-errors
          If set, reports errors at JSON
      --no-lint
          If `true`, disable linters
  -q, --quiet
          Display less output
      --lint
          If `true`, enables extra linters
      --mode <MODE>
          Arbitrary mode -- this will be used to enable or filter user-defined `#[mode(<MODE>)]`
          annotations during compilation
  -e, --build-env <ENVIRONMENT>
          Environment to use for building packages
      --pubfile-path <PUBFILE_PATH>
          Path to ephemeral publication file. When provided, uses ephemeral addresses for
          compilation instead of addresses from the lock file
  -h, --help
          Print help
  -V, --version
          Print version