client

gox client manage the customer frames installed in a GOX project.

Available frameworks are React, Preact, Solid, Vue and Svelte. Check the documentation of Client to know how to declare and use its components.

Use

bash
gox client <command>
CommandDescription
addAdd one or more frameworks.
removeEliminates one or more frameworks.
listShow the installed frameworks.

add

bash
gox client add <framework> [framework...]

It is possible to add one or more frameworks:

bash
gox client add react
gox client add react svelte vue

A new project starts without the folder client/ and with frameworks: {} in gox.jsonThe command. add records the default dependencies of each framework that are not yet declared and retains the existing configurations.

GOX normalizes names, eliminates duplicated arguments and rejects unknown frameworks. For each framework:

  1. It guarantees the availability of Node.js and PNPM.
  2. Create or prepare client/<framework>/.
  3. Install the administered workspace dependencies.
  4. Build the production sales for the requested frameworks.

The accepted frameworks are:

text
react, preact, solid, vue, svelte

remove

bash
gox client remove <framework> [framework...]

The command eliminates:

text
client/<framework>/
.build/client/<framework>/
bash
gox client remove react svelte

The operation fails if any of the requested frameworks are not installed.

list

bash
gox client list

The command shows in alphabetical order the administered frameworks containing a package.json within client/<framework>/.

When no one exists, it shows:

text
No client frameworks installed.

list does not accept arguments.

Managed files

Workplaces and artifacts removed by remove The source components declared in other locations are not automatically removed.

The structure and process of integration are developed in the documentation of statements Client.

Best practices

  • Install only the frameworks used by the project.
  • It adds several frameworks in a single invocation when they are part of the same change.
  • Check existing references before removing a framework.
  • Keep the workspace configuration files under version control.
  • Use list to check the administered status of the project.

See also

Next step

Continue with graph to inspect the Go, GOX and Client dependencies of a project entry.

graph