Skip to main content

CLI tool for MetaV Visual Dashboard Platform

Project description

MetaV CLI (metav-cli)

Command-line interface for MetaV Visual Dashboard Platform.

Installation

Prerequisites

  • Python 3.8+
  • MetaV server running

Install CLI

cd agent-harness
pip install -e .

Configuration

Set environment variables or use command-line options:

export METAV_BASE_URL=http://localhost:10517/metav
export METAV_AUTHKEY=your_auth_key_here

Or use command-line options:

metav-cli --base-url http://localhost:10517/metav --authkey your_key app list

Usage

Authentication

# Login with username/password
metav-cli auth login -u username -p password

# Set authkey
metav-cli auth set-authkey your_auth_key

# Check status
metav-cli auth status

# Logout
metav-cli auth logout

Application Management

# List applications
metav-cli app list
metav-cli app list --page 1 --page-size 50 --keyword search

# Get application details
metav-cli app get <app_id>

# Create application
metav-cli app create --name "My Dashboard" --remark "Created via CLI"

# Update application
metav-cli app update <app_id> --name "New Name" --remark "Updated"

# Delete application
metav-cli app delete <app_id> --force

# Export/Import
metav-cli app export <app_id> --output myapp.zip
metav-cli app import myapp.zip

# Copy application
metav-cli app copy <app_id> --name "Copy of My Dashboard"

# Release/Publish
metav-cli app release <app_id>

Page Management

# List pages
metav-cli page list --app-id <app_id>

# Get page details
metav-cli page get <page_id>

# Create page
metav-cli page create --app-id <app_id> --name "New Page"

# Delete page
metav-cli page delete <page_id> --force

DataSource Management

# List data sources
metav-cli datasource list
metav-cli datasource list --page-size 100

# List all data sources
metav-cli datasource list-all

# Get data source
metav-cli datasource get <datasource_id>

# Create data source
metav-cli datasource create --name "My API" --type restful --config '{"url": "/api/data"}'

# Delete data source
metav-cli datasource delete <datasource_id> --force

Dashboard Operations

# Create dashboard from pageSchema
metav-cli dashboard create --app-name "My Dashboard" --schema schema.json --remark "AI created"

# List available templates (only id/name/placeholders)
metav-cli dashboard templates
metav-cli dashboard templates --name "经营"

# Create dashboard from template json payload
metav-cli dashboard template-create --input template-create.json

# List components
metav-cli dashboard components

# Get dashboard info
metav-cli dashboard info <app_id>

template-create.json example:

{
  "templateId": "2052678820594429952",
  "appName": "模板创建应用",
  "placeholderReplacements": [
    {
      "placeholderId": "aaaaa",
      "name": "monthlyRepairAnalysis",
      "targetItemId": "nkhq0kyjmmo00",
      "target": "component",
      "component": "group-bar-graph",
      "version": "1.0.3",
      "componentConfig": {
        "id": "nkhq0kyjmmo00",
        "title": "分组柱状图",
        "component": "group-bar-graph",
        "version": "1.0.3",
        "x": 761,
        "y": 280,
        "width": 580,
        "height": 171,
        "props": {},
        "dataSource": {}
      },
      "source": "userRequirement",
      "confidence": "high"
    }
  ]
}

说明:

placeholderReplacements 必须为数组,每一项描述一个模板占位替换;
componentConfig 为实际替换到目标占位的组件配置,其他字段用于描述占位、目标和来源信息。

Information Commands

# Current user info
metav-cli info user

# Show configuration
metav-cli info config

# Show session info
metav-cli info session

# Show environment variables
metav-cli info env

JSON Output

Use --json flag for machine-readable output:

metav-cli app list --json
metav-cli app get <app_id> --json

Interactive REPL

metav-cli repl

REPL Commands

metav> app list              # List applications
metav> dashboard components  # List components
metav> auth status           # Show auth status
metav> info config           # Show configuration
metav> exit                  # Exit REPL

Session Management

The CLI stores session data in ~/.metav_session.json:

  • Authentication token
  • User info
  • Default base URL
  • Default app/page IDs

Exit Codes

  • 0: Success
  • 1: API error
  • 2: Configuration error

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

metav_cli-0.2.23.tar.gz (29.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

metav_cli-0.2.23-py3-none-any.whl (38.2 kB view details)

Uploaded Python 3

File details

Details for the file metav_cli-0.2.23.tar.gz.

File metadata

  • Download URL: metav_cli-0.2.23.tar.gz
  • Upload date:
  • Size: 29.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.19 {"installer":{"name":"uv","version":"0.11.19","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":null,"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for metav_cli-0.2.23.tar.gz
Algorithm Hash digest
SHA256 8b3c167885d416973dd6849d3a371a3e3cb222796b93da96af6671facef253d8
MD5 1b903e22f7d0016a6efd1cc5c730134a
BLAKE2b-256 0132f7a8017a857f09f54370a5052c39b84bd5b0e964f90c2acd595cd20ba593

See more details on using hashes here.

File details

Details for the file metav_cli-0.2.23-py3-none-any.whl.

File metadata

  • Download URL: metav_cli-0.2.23-py3-none-any.whl
  • Upload date:
  • Size: 38.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.19 {"installer":{"name":"uv","version":"0.11.19","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":null,"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for metav_cli-0.2.23-py3-none-any.whl
Algorithm Hash digest
SHA256 b389f5d91b70520866d429b85523e5c9cf8da9f40711d0136b07da5440b6fbe6
MD5 db9d347b6e948cb59ae5e50348036ade
BLAKE2b-256 24f263a148f33583cb5b9b34664f983834ec57c6839ce7474e5a6feb0819ebc7

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page