Command Reference

This reference lists all commands available in the AIGNE WebSmith CLI, including their aliases, parameters, and usage examples.

The standard syntax for CLI operations is as follows:

Run Command

aigne web <command> [subcommand] [parameters]

Executing aigne web without a command initiates interactive mode.

Main Commands#

The following table summarizes the primary commands. Each command is detailed further in the sections below.

Command

Aliases

Description

generate

gen, g

Generates a complete website based on a configuration file.

publish

pub, p

Publishes the generated website to a Pages Kit instance.

update

up

Modifies existing website content based on user feedback.

translate


Translates website pages into different languages.

theme


Manages website visual themes, including generation and application.

component

comp

Manages the component library used to build the website.

chat


Starts interactive mode for website management (default).

prefs


Manages saved user preferences learned from feedback.

history


Displays a log of previous updates made to the website.

clear


Removes generated files, workspace data, or configuration settings.


generate#

The generate command orchestrates the creation of a complete website, from planning the site structure to generating page content and templates based on a specified configuration file.

Aliases: gen, g

Usage:

Generate

aigne web generate

Parameters:

config
string
Specifies the file path for the website configuration. This is typically provided automatically.
glossary
string
Path to a glossary file to ensure consistent terminology. Use the format @<file>.
forceRegenerate
boolean
Forces the regeneration of all pages, overwriting any existing generated content.

publish#

The publish command uploads the generated website files to a Pages Kit instance. It manages the batch upload process and provides status monitoring.

Aliases: pub, p

Usage:

Publish

aigne web publish --appUrl "https://example.com"

Parameters:

appUrl
string
The target base URL of the Pages Kit website where the pages will be published.
with-navigations
string
default:menu
Publishes navigation data. Accepted values are 'flat' or 'menu'.
with-locales
boolean
Publishes website locale and language settings when set to true.

update#

The update command modifies the content of an existing website based on user-provided feedback. It can be used to refine text, add or remove sections, or alter page structures.

Alias: up

Usage:

Update

aigne web update --pages "/about" --feedback "Add a mission statement."

Parameters:

pages
array
An array of page paths to be updated (e.g., [\
feedback
string
A description of the required changes or improvements for the specified pages.
glossary
string
Path to a glossary file for consistent terminology. Use the format @<file>.

translate#

The translate command translates the content of existing website pages into one or more specified languages.

Usage:

Translate

aigne web translate --pages "/home" --langs "fr,de,es"

Parameters:

pages
array
An array of page paths to be translated.
langs
array
An array of language codes. Available languages: en, zh, zh-TW, ja, fr, de, es, it, ru, ko, pt, ar.
feedback
string
Specific instructions to guide and improve the quality of the translation.
glossary
string
Path to a glossary file for consistent translation. Use the format @<file>.

theme#

The theme command manages website visual themes, including their generation and application.

Subcommands#

generate Generates a new theme based on the website's design and user suggestions.

Alias: gen

Usage:

Theme Generate

aigne web theme generate --name "CustomTheme"
name
string
A name for the new theme.
config
string
The file path of the website configuration to use as a basis for the theme.

apply Applies a previously generated theme to the website.

Alias: a

Usage:

Apply Theme

aigne web theme apply

This subcommand does not have any specific parameters. It applies the currently configured theme.

component#

The component command manages the component library for the website.

Alias: comp

Subcommands#

pull Pulls components from a specified URL to update the local component library.

Usage:

Component Pull

aigne web component pull --url "https://your-pages-kit/api/..."
url
string
required
The full URL from which to pull the component library.

list Lists the components available in the current library.

Aliases: ls, l

Usage:

Component List

aigne web component list

This subcommand does not take any parameters.

chat#

The chat command starts an interactive session for generating, updating, and managing the website conversationally. This is the default command executed when aigne web is run without specifying another command.

Usage:

Command

aigne web

This command does not take any parameters.

prefs#

The prefs command manages user preferences that WebSmith learns from feedback to customize AI behavior.

Subcommands#

list Lists all saved user preferences.

Alias: ls

Usage:

List Preferences

aigne web prefs list

This subcommand does not take any parameters.

remove Removes one or more specified preferences.

Alias: rm

Usage:

Prefs Remove

aigne web prefs remove --id "pref_abc123"
id
array
required
An array of preference IDs to be removed.

toggle Toggles the active status of one or more preferences.

Alias: t

Usage:

Prefs Toggle

aigne web prefs toggle --id "pref_abc123"
id
array
required
An array of preference IDs whose status will be toggled.

history#

The history command is used to view the update history of the website content and structure.

Subcommands#

view Displays the update history in a compact, log-style format. Each entry includes a hash, date, operation, and the associated feedback.

Aliases: log, list

Usage:

History View

aigne web history view

This subcommand does not take any parameters.

clear#

The clear command removes generated files, workspace data, or configuration settings from the project directory.

Usage:

Clear

aigne web clear --targets "generatedPages" "websiteConfig"

Parameters:

targets
array
An array of items to clear without prompting. Valid items are: websiteStructure, generatedPages, websiteConfig, deploymentConfig, authTokens, mediaDescription, translationCaches.
pagesDir
string
Overrides the default directory path for source pages.
tmpDir
string
Overrides the default directory path for the temporary workspace.
outputDir
string
Overrides the default directory path for generated pages.
configPath
string
Overrides the default path for the configuration file.


Summary#

This reference guide has detailed the primary commands and parameters for the AIGNE WebSmith CLI. For task-oriented instructions, refer to the guides in the Guides section of the documentation.

Reference
Config Reference