Integrations

Editors

Atom Editor

This package offers Cacher users the ability to perform popular actions on their personal and team snippet libraries from within the editor.

Atom Cacher demo

Prerequisites

Getting started

  1. Install the Cacher for Atom package using apm: apm install cacher
  2. Once Atom has loaded, you will be prompted to setup Cacher. Click the Setup Cacher button. info_outlineYou can also start the setup wizard by using the Cacher: Setup command.
    Setup Cacher
  3. In the prompt to "Enter Cacher Credentials", click the Open Cacher link to view your API credentials. info_outlineYou can also navigate to the page via: app.cacher.io/enter?action=view_api_creds
  4. From the popped up webpage, sign up or sign in as a Cacher user.
  5. Once you are signed into Cacher, you should see a dialog on the top-right corner with your API KEY and API TOKEN values.
    API credentials
  6. Back in Atom, enter your API key and token from step 5 into the prompt.
  7. You're all set! Open the Command Palette and type in Cacher: Find Snippet to search for a snippet from your Cacher libraries.
notes Note: Your credentials are saved in .cacher/credentials.json under your OS's home folder. This file is also used to authenticate other apps, like the Cacher CLI, VSCode Extension and Sublime Text Package.

Commands

Find Snippet

Shortcut: Alt Shift I

Find a snippet from your personal and team Cacher libraries. Searches across snippets' title, description and file content.

Once you've found what you're looking for, you'll see buttons in the footer to:

Create Snippet

Shortcut: Alt Shift C

Create a snippet from either the text selection or the entire file (no selection). The command starts a wizard for you to choose:

Refresh Snippets

Shortcut: Alt Shift R

Reload your Cacher snippets. Do this once you've made a change to your snippets outside of VSCode.

notes Note: The extension auto-refreshes once every hour.

Setup

Kick off the setup wizard to authenticate your Cacher account. Run this command if you need to switch users.

Context Menu

Right-click on an active editor to bring up Cacher context menu actions:

Contributing

Thanks for deciding to help!

You can find the GitHub repo at: github.com/CacherApp/cacher-atom

Cacher for Atom is written in ES7 and transpiled with Babel. The Atom Flight Manual has an excellent guide on writing plugins.

Before submitting a pull request, be sure to check for errors with ESLint: npx eslint .

License

This project is licensed under the MIT License - see the LICENSE file for details.

On this page