Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,15 +30,15 @@ stellarforge test
stellarforge deploy
```

These commands are planned and will become available incrementally through the roadmap. Do not assume a command documented here is implemented until the corresponding release notes state that it is available.
These MVP commands are now implemented in the repository. The package remains under active pre-v1 development and is not yet presented as a stable published npm release. See the [Command Reference](docs/reference/commands.md) for exact behavior.

---

## Current MVP Scope

### Project Scaffolding

Planned command:
Implemented command:

```bash
stellarforge new my-app
Expand All @@ -59,7 +59,7 @@ Additional domain templates may be considered after the MVP based on validated d

### Environment Diagnostics

Planned command:
Implemented command:

```bash
stellarforge doctor
Expand All @@ -69,7 +69,7 @@ Diagnostics will check the developer tooling required by supported workflows and

### Local Development

Planned command:
Implemented command:

```bash
stellarforge dev
Expand All @@ -79,7 +79,7 @@ This command will orchestrate supported local-development processes; it will not

### Unified Testing

Planned command:
Implemented command:

```bash
stellarforge test
Expand All @@ -89,7 +89,7 @@ The CLI will provide a consistent entry point for supported project tests while

### Stellar Testnet Deployment

Planned command:
Implemented command:

```bash
stellarforge deploy
Expand Down Expand Up @@ -147,7 +147,7 @@ See [SECURITY.md](SECURITY.md), the [threat model](docs/architecture/threat-mode
| `stellarforge --help` | Display CLI usage/help | Planned |
| `stellarforge --version` | Display CLI version | Planned |

`stellarforge add`, plugin architecture, and remote template registries are **post-v1 candidates**, not MVP commitments.
`stellarforge add`, plugin architecture, remote template registries, and Mainnet deployment are **not implemented** and remain post-v1 or separately reviewed candidates.\n\nSee [Quick Start](docs/guides/quick-start.md), [Command Reference](docs/reference/commands.md), [Configuration](docs/reference/configuration.md), and [Troubleshooting](docs/reference/troubleshooting.md).

---

Expand Down
4 changes: 1 addition & 3 deletions docs/guides/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,9 +43,7 @@ node dist/cli.js

The package metadata maps the installed command name `stellarforge` to `dist/cli.js`. When the package is eventually installed or linked through an approved workflow, package managers can expose that executable as `stellarforge`.

At the CLI-002 stage, successful startup intentionally produces no command output. The root command, global help, and invalid-command behavior are implemented separately in CLI-003.

Do not install undocumented global dependencies. Stellar-specific tools required by individual commands will be documented with those commands and validated by `stellarforge doctor` where applicable.
After building, verify the executable with:\n\n```bash\nnode dist/cli.js --help\nnode dist/cli.js --version\n```\n\nThe implemented command behavior is documented in the [Command Reference](../reference/commands.md).\n\nDo not install undocumented global dependencies. Stellar-specific tools required by individual commands will be documented with those commands and validated by `stellarforge doctor` where applicable.

## Package Publication

Expand Down
66 changes: 53 additions & 13 deletions docs/guides/quick-start.md
Original file line number Diff line number Diff line change
@@ -1,47 +1,87 @@
# Quick Start

This guide describes the intended MVP workflow. Commands may remain unavailable until their implementation issues are merged.
This guide uses the currently implemented StellarForge CLI MVP commands.

## Create a Project
For contributor installation, see [Installation](installation.md). For full options and failure behavior, see the [Command Reference](../reference/commands.md).

## 1. Create a project

The default template is `basic-app`:

```bash
stellarforge new my-app
cd my-app
```

Select one supported MVP template: Basic App, Full Stack App, Stellar smart contract, or API Service.
Or choose one of the other bundled templates:

```bash
stellarforge new my-api --template api-service
stellarforge new my-contract --template smart-contract
stellarforge new my-stack --template full-stack
```

## Validate Your Environment
Supported template IDs are `basic-app`, `full-stack`, `smart-contract`, and `api-service`.

## 2. Validate your environment

```bash
stellarforge doctor
```

Diagnostics should identify missing or incompatible developer tools and provide remediation guidance without exposing sensitive environment values.
The command checks the supported local toolchain and prints remediation guidance. A failed required diagnostic exits with code `5`.

## 3. Run local development

## Develop
From a supported generated Node.js project:

```bash
stellarforge dev
```

The CLI will orchestrate supported local-development processes for generated projects.
StellarForge looks for a supported npm development script: `dev`, then `start`, then `start:backend`.

## Test
## 4. Run tests

```bash
stellarforge test
```

The command should preserve meaningful test failures and exit codes.
Node.js projects use `npm run test`; Cargo projects use `cargo test`.

## Deploy to Testnet
## 5. Configure Testnet deployment

For a smart-contract project, create `stellarforge.config.json` at the project root:

```json
{
"version": 1,
"network": "testnet",
"identity": "deployer"
}
```

The identity must already exist in Stellar CLI identity management. Do not place raw secret keys or seed phrases in project configuration.

See the [Configuration Reference](../reference/configuration.md).

## 6. Deploy to Testnet

```bash
stellarforge deploy
```

The v1 MVP targets Stellar Testnet. Mainnet deployment automation is explicitly outside the MVP.
Or override configuration explicitly:

```bash
stellarforge deploy --network testnet --source deployer
```

The MVP deployment path is Testnet-only. Mainnet deployment is not implemented.

## Current Status
## Next references

Use the repository README and ROADMAP as the source of truth for which commands are available versus planned.
- [Command Reference](../reference/commands.md)
- [Troubleshooting](../reference/troubleshooting.md)
- [Exit Code Policy](../reference/exit-codes.md)
- [Security Policy](../../SECURITY.md)
Loading
Loading