Skip to content

Workflow

fw_setup

Check Stata, system tools, backends, and the Cloud connection

fw_setup checks everything Framework for Stata uses and prints the next step for anything missing:

  • the Stata version and where the package is installed
  • the project at or above the current folder
  • curl, the SHA-256 tool, and the system keyring
  • the Framework Cloud server and whether this computer is connected, and the project's server when it differs
  • fw, the command-line tool, and its version
  • Stata's Python and whether framework-py is installed in it
  • the backend setting

When framework-py is missing from Stata's Python, fw_setup prints the pip command for that exact Python.

Usage

fw_setup [, nopython nonetwork url(string)]

Options

Name Description
nopython

Skips the Python check. Checking Python starts Stata's Python for the session, and Stata cannot change Python after that.

nonetwork

Skips the request that confirms the Cloud login.

url(string)

Checks a Framework Cloud server other than the default.

Value

r(steps): the number of next steps printed.

Examples

fw_setup

Without starting Python

fw_setup, nopython nonetwork

Related reference