Skip to content

How does this tool work?

Jump to bottom
Evan Ugarte edited this page Jan 17, 2022 · 3 revisions

This tool is interested in:

  • making sce services as simple as possible to run
  • cloning and setting up sce projects on a users computer
  • running tests (e.g. api test, linting) on projects to help users verify code functionality

Upon successful installation of this tool, users can run commands with the sce prefix: image

The magic of this varies depending on the OS. Below explains the differences across each.

How does this work on Windows?

On Windows, the sce tool compiles itself into an executable file with CX_Freeze. We the add the path of the executable to the Windows user's path so it can be accessed from within the command line. The code to add the Windows alias is in tools/setup.py:105 For more information on how CX_Freeze works check out this page.

How does this work on Unix (Mac and Linux)?

When the user runs setup (steps are in README.md), the command adds itself as an alias in either .zshrc or .bashrc for Mac or Linux respectively. The code to handle adding the alias is in tools/setup.py:94

Clone this wiki locally