Reco – Tool Usage Reference

Use our tool, reco, to simulate, build and deploy your code in the cloud.

reco is accessed from the command line like this: reco [command] [subcommand]

Here is a full list of available commands:

Development Subcommands Description
build list List all builds for your currently active project
  log <build_ID> Stream logs for a build – this is useful for viewing logs for a cancelled build or if you opted not to wait for the build to finish
  run Start a new build using the program at your current location
  stop <build_ID> Stop a build
  report <build_ID> View a a build report to see FPGA resource usage stats
check Check code for compatibility with our compiler
graph gen Generate a dataflow graph for the program at your current location
  list List all available graphs along with their unique IDs
  open <graph_ID> Open a specific graph in your defualt PDF viewer
deploy list List all deployments for your currently active project
  log <deployment_ID> Stream logs for a deployment
  run <build_ID> <my_cmd> Deploy your build to an FGPA and run your chosen command
  stop <deployment_ID> Stop a deployment
  connect <deployment_ID> Each deployment is assigned a unique ip address, this command connects you to that ip.
sim list Simulate how your program will run on an FPGA
  log <sim_ID> Stream logs for a build – this is useful for viewing logs for a cancelled build or if you opted not to wait for the build to finish
  run <my_cmd> Start a hardware simulation using the program at your current location
  stop <sim_ID> Stop a simulation
Other Subcommands Description
auth Authenticate your account using your invite token - this must be completed before you can start using reco
completion Enable bash completion
Project create <my_project> Create a new project
  list List all your projects
  set <my_project> Set one of your projects to be active
update Update the reco command line tool
version See which version of the app you are using
Flags:
  -h, --help            help for reco
  -m, --message         include a short message with a build - this is only available for builds at this time
  --project string      project to use. If unset, the active project is used
  --public              only display public builds
  -s, --source string   source directory (default is current directory "<your-directory")

  Use "reco [command] --help" for more information about a command.

For more complex workflows…

reco has been designed to fit easily into scripts so it can be integrated into projects which require elements of automation.