Skip to main content

Accio CLI

Accio provides a user-friendly CLI tool to help you set up and serve your Accio instance. Let's take a quick look at what the Accio CLI can do for you.

Usage​

Usage: accio [options] [command]

Options:
  -h, --help                      display help for command

Commands:
  version                         Show the version of CLI and Accio packages
  init [path]                     Initialize Accio with a template MDL in the specified directory
  hello                           Quick-start to try Accio
  build [path]                    Convert Accio MDL to the manifest JSON file in the specified directory
  serve [path]                    Build Accio MDL in the specified directory and start Accio server
  cli                             Run psql CLI in the specified directory
  stop                            Stop Accio server
  demo                            Start demo database
  help [command]                  display help for command

You can use the accio command followed by the desired command and options to perform various tasks. Here are the available commands:

  • version: Show the version of the CLI and Accio packages.
    • Usage: accio version
  • init [path]: Initialize Accio with a template MDL in the specified directory.
    • Usage: accio init [path]
    • Options:
      • t, --template <template>: Template to use.
      • o, --output <output>: Output MDL file name.
  • hello: Quick-start to try Accio.
    • Usage: accio hello
note

The hello command is a combination of multiple commands. When executed, it performs a sequence of actions including running init with the example template, executing build, demo, and serve consecutively.

  • build [path]: Convert Accio MDL to the manifest JSON file in the specified directory.
    • Usage: accio build [path]
    • Options:
      • o, --output <output>: Output manifest json file name.
      • i, --input <input>: Input MDL file name.
  • serve [path]: Build Accio MDL in the specified directory and start Accio server.
    • Usage: accio serve [path]
    • Options:
      • o, --output <output>: Output manifest json file name.
      • i, --input <input>: Input MDL file name.
  • cli: Run psql CLI in the specified directory.
    • Usage: accio cli
  • stop: Stop Accio server.
    • Usage: accio stop
  • demo: Start the demo database.
    • Usage: accio demo
  • chatgpt:plugin [path]: Start ChatGPT Plugin Web server in the specified directory.
    • Usage: accio chatgpt:plugin [path]
    • Options:
      • -i, --input <input>: Input MDL file name.

You can also use the help command followed by a specific command to get detailed information about that command. For example: accio help build will display help for the build command.

About Accio Services​

PortPurposeComponent
7432Accio Engine SQL Executionaccio-engine
8080Accio Engine API Interfaceaccio-engine
3000Accio User Interface (UI)accio-ui
  • Port 7432: This port is used by the Accio Engine specifically for executing Accio SQL queries and handling the parsing and execution of the queries.
  • Port 8080: The Accio Engine exposes an API interface on this port. It allows communication with the engine, providing functionalities such as executing queries, managing schemas, and more.
  • Port 3000: The Accio User Interface (UI) is accessible on this port. It provides a visual representation of the relationships between Accio MDL files and allows you to explore and interact with the data model.

Please note that after running the accio hello command, make sure these ports are available and not being used by other applications on your system.