Install Datadog CoTerm

Cette page n'est pas encore disponible en français, sa traduction est en cours.
Si vous avez des questions ou des retours sur notre projet de traduction actuel, n'hésitez pas à nous contacter.

CoTerm is supported on macOS and Linux.

  1. Install Datadog CoTerm with Homebrew or curl:

    brew (macOS only)

    brew install coterm
    

    curl

    curl --tlsv1.2 --proto '=https' -sSf 'https://coterm.datadoghq.com/install-ddcoterm.sh' | bash
    

    This command downloads the latest version of CoTerm to .ddcoterm/bin/ddcoterm and updates your PATH in .bashrc and .zshrc. Restart your terminal or source your profile. If you are using a shell other than Bash or Zsh, add path/to/.ddcoterm/bin to your PATH manually.

  2. If your Datadog site is not https://app.datadoghq.com, set your site in .ddcoterm/config.yaml under connection_config.host:

    ...
    connection_config:
      host: 
    ...
    
  3. Initialize your configuration file by running:

    ddcoterm init
    

    Select your settings. You can change these settings in the ~/.ddcoterm/config.yaml file.

Authorize CoTerm to connect to Datadog

During initialization, you can choose one of the following ways to authorize CoTerm to access your Datadog Account:

  • OAuth: Opens a browser for you to log in with OAuth.
  • API Key + App Key: Prompts you to set your Datadog API key and application key in ~/.ddcoterm/config.yaml.
  • API Key Only: Prompts you to set your Datadog API key in ~/.ddcoterm/config.yaml.
If you select the API Key Only option, you cannot require approvals with Case Management.

Configure your CoTerm settings

The ~/.ddcoterm/config.yaml file contains your CoTerm configurations:

process_config
Configure CoTerm to act as a linter and take certain actions when it intercepts a command that matches a rule. See CoTerm Configuration Rules.
enable_telemetry
Enable or disable sending telemetry to Datadog. Defaults to false.
enable_ptrace
Enable or disable experimental ptrace-based process monitoring on Linux. Defaults to false.
connection_config
host
Host for connecting to Datadog. Defaults to https://app.datadoghq.com.
port
Port for connecting to Datadog. Defaults to 443.
api_key
If you are not using OAuth, your Datadog API key. If you have enabled OAuth, CoTerm defaults to using OAuth and ignores api_key.
app_key
If you are not using OAuth, your Datadog application key.
Note: To require approvals with Case Management, you must use OAuth or specify both your API key and application key in this file.

Next steps

  • Run ddcoterm to start a recorded terminal session.
  • Learn more about using CoTerm.

Uninstall

To uninstall CoTerm, delete the .ddcoterm folder.

Further reading