Cased

Cased developer and API documentation

Add a comprehensive, high-signal, and tamper-proof audit trail to any application in minutes. Give your compliance, security, and customer support teams the information they need.

FAQ

Answers to common questions and advice on resolving possible issues.

If you run into any of these issues, please try the following solutions. You can also always contact [email protected].


"I can't install the Cased client after running the one-line installation script"

  • The one-line installation script requires that Python 3, as well as git, are installed and on your PATH.

  • If necessary, you can always install the client manually. You will still need Python3.

  • Remember that cased is a system-level program in order to work with your system shell, and will create two programs, cased and cased-init, which will then be available on your PATH.


"I added a command-line program to Cased, but when I run it, it's not guarded."

  • Make sure cased-init has been run. The typical way to do this is by adding: eval "$(cased-init -)" to your .bashrc or .zshrc, or similar file. This script adds a shims directory to your PATH, which allows Guard to work. Load a new shell (run /bin/bash, or just open a new terminal) for this change to take effect.

  • Make sure cased sync has been run since you last added the program. It is can be run manually, run every time your shell starts, or run with a cron. Additionally, if without those options, cased sync is automatically run whenever an already -guarded program is executed. (Please note, if you've just installed Cased CLI, running cased sync shouldn't necessary, since cased configure also runs cased sync. In any case, it is always harmless to run cased sync multiple times).

  • Run cased verify to confirm that these steps have been executed, and the client is properly installed.


"I got an error like "Permission denied" while installing."

  • You may not have access to necessary system directories. You can try running the installation script with sudo. If you still have issues, please contact us.

"While installing, I got this error:"

  The following error occurred while trying to add or remove files in the
  installation directory:  

  [Errno 2] No such file or directory: '/usr/local/lib/python3.5/site-packages/test-easy-install-8816.pth'. 

  The installation directory you specified (via --install-dir, --prefix, or
  the distutils default setting) was:  

  /usr/local/lib/python3.5/site-packages/
  • You are missing the Python site-packages directory. The installation script should detect this and will tell you how to resolve it with directions specific to your system.

"Installing gives me an error like: "

ERROR: Could not find a version that satisfies the requirement cased (from versions: none)
ERROR: No matching distribution found for cased

You are likely trying to install cased with python 2, or are using a version of older version of Python3. cased requires Python 3.5 or better.

"When running my guarded programs inside a script, instead of from the command-line, the program hangs or has other issues".


"I'd like to uninstall the client"

  • Since the Cased client is so lightweight, you can simply remove the eval "$(cased-init -)" from your shell startup script, and open a new shell. Programs will no longer be guarded.

  • To completely remove a Cased client install, you can rm the ~/.cguard/ directory, where the client stores data, although this isn't strictly necessary. You can also remove the cased and cased-init programs, which are likely in /usr/local/bin/ or a similar location (try which cased to find their location.)

Updated 10 days ago


FAQ


Answers to common questions and advice on resolving possible issues.

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.