@maligator/cli 0.1.0-alpha.3 → 0.1.0-alpha.30

package/README.md

@@ -38,7 +38,7 @@ maligator run -- first-argument "two words"
 
 `maligator init` creates `maligator.build.ts`. If it cannot find an existing entry
 point, it also creates `src/index.ts`. `doctor` checks the native build toolchain,
-`build` produces a development executable, and `run` builds and launches it while
+`build` produces a development executable, and `run` compiles a development image and executes it while
 forwarding everything after `--` to the application.
 
 Useful commands:
@@ -50,99 +50,51 @@ maligator init
 maligator doctor [--verbose] [--target rust-triple]
 maligator build [entry] [--production] [--artifact directory] [--target rust-triple] [--config path]
 maligator run [entry] [--config path] [-- args...]
+maligator dev [entry] [--config path] [-- args...]
+maligator test [path ...] [--run name] [--shuffle [seed]] [--repeat count] [--bail]
 ```
 
 Run commands from the project root. Maligator does not search parent directories
 for configuration.
 
-## Production builds
-
-Use production mode for a deployable binary:
-
-```shell
-maligator build --production
-```
-
-Production builds use optimized native compilation, add LTO when the toolchain
-supports it, and strip native symbols when possible. To create a self-contained
-artifact directory with a manifest, license, checksum, and binary:
-
-```shell
-maligator build --production --artifact dist/my-application
-```
-
-The artifact destination must be absent or empty. Launch the reported binary
-directly; neither Node.js nor the Maligator CLI is needed at runtime.
-
-## Configuration
-
-`maligator.build.ts` is trusted TypeScript configuration. A small configuration
-looks like this:
-
-```typescript
-import { defineBuild } from "@maligator/cli";
-
-export default defineBuild({
-	entry: "src/index.ts",
-	outputName: "my-application",
-	engine: {
-		eval: false,
-		intl: { enabled: false },
-	},
-	surface: {
-		webPlatform: false,
-		node: false,
-	},
-});
-```
-
-All fields are optional. Maligator excludes optional engine and host surfaces unless
-the configuration requests them. See the
-[full configuration reference](https://github.com/dirkdev98/maligator#configuration)
-for assets, Intl features, Node compatibility, web-platform support, and target
-selection.
-
-## TypeScript
-
-The package includes declarations for `maligator.build.ts` and Maligator's runtime
-globals. Keeping the generated build file inside your TypeScript project makes the
-types available automatically:
-
-```typescript
-const path = mal.assets.materialize("templates", {
-	baseDirectory: ".cache/my-application",
-});
-
-const server = Mal.serve({
-	hostname: "127.0.0.1",
-	port: 3000,
-	async fetch(request) {
-		return new Response(`Hello from ${request.url}`);
-	},
-});
-
-console.log(path, server.port);
-```
-
-`mal` is present when `surface.maligator` is enabled. `Mal` and `Mal.serve` are
-present when `surface.webPlatform` is enabled. The declarations describe both
-optional surfaces, while `maligator.build.ts` controls which globals exist in the
-compiled application.
-
-If your `tsconfig.json` excludes `maligator.build.ts`, load the declarations
-explicitly:
-
-```json
-{
-	"compilerOptions": {
-		"types": ["@maligator/cli"]
-	}
-}
-```
+`run` and `dev` use compile-time-specialized runtimes embedded in the platform
+package for locked or mutable primordials, configured assets, the Web and Node
+surfaces, and Realm support when Intl is disabled. Those profiles do not need a local
+native toolchain. `dev` retains compiler identities between edits and restarts a fresh
+application VM after every successful rebuild. Build failures keep the watcher alive
+for recovery on the next edit.
+
+## Documentation
+
+Use the [guides](https://maligator.ddv.tools/guides) for application workflows and
+the [API reference](https://maligator.ddv.tools/api) for exact contracts.
+
+- [Getting started](https://maligator.ddv.tools/guides/getting-started)
+- [Development](https://maligator.ddv.tools/guides/development) and
+  [TypeScript](https://maligator.ddv.tools/guides/typescript)
+- [Application testing](https://maligator.ddv.tools/guides/testing)
+- [Workers](https://maligator.ddv.tools/guides/workers)
+- [Build configuration](https://maligator.ddv.tools/guides/build-configuration)
+- [Embedded files](https://maligator.ddv.tools/guides/assets) and
+  [HTTP](https://maligator.ddv.tools/guides/http)
+- [Production](https://maligator.ddv.tools/guides/production) and
+  [profiling](https://maligator.ddv.tools/guides/profiling)
+- [CLI commands and flags](https://maligator.ddv.tools/api/cli)
+
+The package ships types for configuration, runtime globals, and public `maligator:`
+modules. Include `@maligator/cli` in `compilerOptions.types` when your TypeScript
+project excludes the build file. Declarations do not enable optional runtime surfaces;
+choose those in `maligator.build.ts`.
+
+Every page has a Markdown counterpart. The
+[public symbol index](https://maligator.ddv.tools/reference.json) provides signatures,
+defaults, availability, and direct links.
 
 ## Build toolchain
 
-The compiler CLI is prebuilt, but compiling an application requires:
+`maligator test` and supported `maligator run` profiles use the development runtime
+embedded in the platform CLI and do not require a native toolchain. Native `build`
+commands and development runs using Intl require:
 
 - A C23 compiler and archive tool: Apple clang, clang 19 or newer, or GCC 15 or
   newer
@@ -152,15 +104,14 @@ The compiler CLI is prebuilt, but compiling an application requires:
 On macOS, install Apple command-line tools with `xcode-select --install`. On Linux,
 install a recent compiler and set `CC` and `CXX` when it is not your system default.
 Run `maligator doctor --verbose` for resolved tool paths, versions, capabilities,
-and installation hints. The
-[native toolchain guide](https://github.com/dirkdev98/maligator#native-toolchain)
-has the full requirements and cross-compilation instructions.
+and installation hints.
+[Set up native builds](https://maligator.ddv.tools/guides/native-toolchain) has the
+full requirements and cross-compilation instructions.
 
 ## Alpha support
 
-`0.1.0-alpha.1` provides native packages for macOS and glibc-based Linux on arm64
-and x64. Later alpha releases currently default to Apple Silicon macOS; consult the
-release notes before upgrading on another host. Windows is not supported.
+Native packages cover macOS and glibc-based Linux on arm64 and x64. Windows is not
+supported.
 
 There is no source-build fallback for the CLI package. The alpha binaries are
 unsigned, and macOS binaries are not notarized. APIs, configuration, and supported