Cloud

fw structures list

structures list

List project structures on Framework Cloud

Added in 0.3.0.

Lists the project structures you can start a project from: Framework's, your own, and the ones shared with you. A structure is the folders and Framework's core files. Pass a key to fw new --structure.

Usage

fw structures list [flags]

Options

Name Type Description
--json bool

print JSON on stdout, for scripts and agents

--lang string

only pieces for this language: r, python, or stata

--url string

Framework Cloud server

Environment variable: FW_CLOUD_URL

Value

With --json, {"server": ..., "structures": [...]}, each with key, name, description, type, version, system, and visibility.

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 structures list
fw structures list --lang stata --json

Related reference