Eodash Command Line Interface

eodash CLI wraps Vite to serve and build your dashboard, providing an optimized development experience and producing minified ESM bundles for production.

dev

Starts vite's dev server.

usage

eodash dev

options

Option	Description	Default
-v, --version	output the current version	--
--publicDir <path>	path to statically served assets folder	/public
--no-publicDir	do not serve static assets	--
-e, --entryPoint <path>	file exporting `createEodash`	src/main.js
-w, --widgets <path>	folder that contains vue components as internal widgets	src/widgets
--cacheDir <path>	set cache folder	.eodash/cache
-r, --runtime <path>	file exporting eodash client runtime config	src/runtime.js
-b, --base <path>	base public path	/
-p, --port <port>	serving port	--
-o, --open	open default browser when the server starts	false
-c, --config <path>	path to eodash server and build configuration file	eodash.config.js
--host [IP address]	specify which IP addresses the server should listen on	false
--no-host	do not expose server to the network	--
-l, --lib	builds and serves eodash as a web component	false
--no-lib	builds and serves eodash as an SPA	--

build

Builds eodash for production

usage

eodash build

options

Option	Description	Default
-v, --version	output the current version	--
--publicDir <path>	path to statically served assets folder	/public
--no-publicDir	do not serve static assets	--
--outDir <path>	sets the minified output folder	.eodash/dist
-e, --entryPoint <path>	file exporting `createEodash`	src/main.js
-w, --widgets <path>	folder that contains vue components as internal widgets	src/widgets
-r, --runtime <path>	file exporting eodash client runtime config	src/runtime.js
-c, --config <path>	path to eodash server and build configuration file	eodash.config.js
-l, --lib	builds and serves eodash as a web component	false
--no-lib	builds and serves eodash as an SPA	--

preview

Locally preview the production build. This is not intended to be used for production.

usage

eodash preview

options

Option	Description	Default
-v, --version	output the current version	--
-b, --base <path>	base public path	/
-p, --port <port>	serving port	--
-o, --open	open default browser when the server starts	false
--host [IP address]	specify which IP addresses the server should listen on	false
--no-host	do not expose server to the network	--

Configuration

While running the eodash command line, it automatically tries to locate a configuration file named eodash.config.js from the root folder of your project. You can also explicitly specify a config file to use with the --config or -c CLI option (resolved relative to your projects root folder). You can also override the configuration values using the CLI options. refer to the API to learn more:

eodash.config.js Basic Example

export default {
    lib: false,
    dev: {
        port: 3333,
        open: true
    }
    ...
}

Integrate your IDE’s intellisense

with eodash’s TypeScript typings using jsdoc hints

/** @type {import("@eodash/eodash/config").EodashConfig} */
export default {
    ...
}

Or using the defineConfig helper function

import { defineConfig } from "@eodash/eodash/config"
export default defineConfig({
    ...
})