Skip to content
This repository has been archived by the owner on Nov 1, 2022. It is now read-only.

Latest commit

 

History

History
115 lines (71 loc) · 6.17 KB

TROUBLESHOOTING.md

File metadata and controls

115 lines (71 loc) · 6.17 KB

Troubleshooting

Updating to the latest version

We will try to release fixes for issues as we discover them. Try updating to the latest version if you encounter any issues:

twilio plugins:uninstall @twilio-labs/plugin-signal2021
twilio plugins:install @twilio-labs/plugin-signal2021@latest

Common Issues

Can't login

The SIGNAL Developer Mode prompts you for your SIGNAL 2021 credentials. These are not your regular Twilio credentials.

To check if you are using the right credentials, try logging into signal.twilio.com/login.

No download & setup option

The "download & setup" option will only show up if we were able to detect git running on your system. It has to be part of your PATH for us to detect it. You can still use the "view source" option to open the relevant GitHub project and download it from there.

Dependencies are not installed when downloading a sample

Right now we are only supporting installing dependencies in Node.js projects. For any other programming languages you'll have to manually installed the dependencies. Check the README.md file of the project that was created by SIGNAL Developer Mode for relevant instructions.

Odd layout or no content

We tried to test as many terminal sizes as possible and will adjust the content according to your terminal size. In some edge cases it might still cause odd rendering. Try resizing your terminal window size or your font size. If that does not fix the issue, [report an issue][#reporting-an-issue].

Flickering

SIGNAL Developer Mode uses a React-based framework called ink. The way it renders output can cause flickering in some terminal applications. If we detect you are using a terminal that has a bad flickering problem we'll turn off animations which will reduce the amount of flickering. However, any interaction itself might still cause flickering.

Reducing the terminal size can improve the situation in some terminals. Some of the terminals that we found that were doing a good job of not flickering are: Hyper, the built-in macOS Terminal.app and cmder on Windows.

If animations were not turned off automatically or you'd want to turn them off explicitly, you can set an environment variable of FORCE_ANIMATION to the value of 0. In Linux and macOS you can do this by running:

export FORCE_ANIMATION=0
twilio signal2021

For a guide for Windows checkout this article on setting environment variables.

I can't identify some of the colors

By default we are coloring the output of SIGNAL Developer Mode. You can turn that off at any point by setting an environment variable with the key FORCE_COLOR and the value 0. In Linux and macOS you can do this by running:

export FORCE_COLOR=0
twilio signal2021

For a guide for Windows checkout this article on setting environment variables.

All URLs that get opened contain UTM tags. I don't want that.

You can turn this off by setting the following environment variable SIGNAL_NO_UTM to True. For example in Linux or macOS:

export SIGNAL_NO_UTM=True
twilio signal2021

For a guide for Windows checkout this article on setting environment variables.

You can also set SIGNAL_NO_DIAGNOSTICS=True to not send anonymous diagnostics information.

Check out our privacy policy on how Twilio handles data.

I have an issue I can't find here

If you can't find your issue here, make sure to also check the issues on this project for any existing issues.

For anything that can't be found there, consider reporting an issue.

Reporting an Issue

If you are encountering any issue that you can't find listed above, please reach out and we'll try to help you.

Support channels

For any paid-ticket holders, you can start by reaching out to our SIGNAL Concierge at the bottom corner of the SIGNAL 2021 website.

Alternatively, anyone can open a public GitHub issue on this project.

Important. Please don't try to reach out via email to any of the maintainers. The channels mentioned above are being monitored during SIGNAL and will result in the fastest help. Email requests might not get answers until after the show.

Providing information when requesting help

There are two pieces of information that you can give us to better help you tracking down the issue.

  1. Please provide us with the diagnostics information that will be output when you run twilio signal2021 --diagnostics -o=json.
  2. Additionally a screenshot of the issue, if possible, can be useful.
  3. During the debugging you might be asked to run twilio signal2021 -l debug, which will stop overriding your content to display any errors that might be output. It will also tell you before logging in, where you can find the full log file as you might be asked for that.