Projects

fw project push-spec

project push-spec

Send this project's spec to Framework Cloud

Added in 0.2.0.

Sends .framework/spec.json to the project on Framework Cloud, which shows it on the project page. The spec describes the project's structure: folders, settings, packages, and templates. It never holds data, and the server refuses secret values in it. It uses the project token in .env.

When the project's full path contains "private", fw warns and asks first. With --json or no terminal, it stops with exit code 6 unless you pass --include-private.

Usage

fw project push-spec [flags]

Options

Name Type Description
--include-private bool

send the spec without asking when the project's path contains "private"

--json bool

print JSON on stdout, for scripts and agents

--url string

Framework Cloud server (default: the project's FW_CLOUD_URL)

Environment variable: FW_CLOUD_URL

Value

With --json, received_at, spec_version, and changed, which is false when the cloud already had this spec.

Exit codes

Code Meaning
0 Success
1 Failure
2 Bad flags or arguments
3 Not logged in, or the server rejected the token
4 The server has no such project or resource
5 Browser login was denied, or its code expired
6 An upload has "private" in a path; rerun with --include-private if you mean to send it

With --json, a failure also prints one JSON line on stderr: {"error": "...", "exit_code": 4}. Exit code 6 adds "reason": "private_path".

Examples

Not run

fw project push-spec
fw project push-spec --json

Related reference