Skip to content
This repository has been archived by the owner on Oct 27, 2021. It is now read-only.
/ octophus Public archive

:octocat: Live load and edit files from a remote repo on GitHub in atom.

License

Notifications You must be signed in to change notification settings

octophus/octophus

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Octophus

Live load and edit files from a remote repo on GitHub in atom. Simple and fast!

image

Installation

apm install octophus

or

Search for octophus within package search in the Settings View.

Usage

SET UP YOUR GITHUB TOKEN FIRST! Octophus needs read and write access to your GitHub repo. So make sure you generated a private access token for Octophus and write it in package settings.

Octophus: Open GitHub Repo control-option-command-O will open a remote repo from GitHub and load it into your atom editor.

Octophus: Update with Message control-option-command-K will allow you to save changes with your own message.

As you save the file in the editor, the file in your remote repo will be updated as well. Note that there would never be a "commit storm", any new changes will be smartly integrated into one commit.

Configuration

Go to Package Settings page to finish the configuration.

image

Github Token is the Private Access Token generated by GitHub, allowing Octophus to read and write files in your GitHub repo. This must be set before any other actions.

Save Timeout is the minimum interval to upload your changes into GitHub. By default it is set to 10s. This option is intended to avoid frequent network requests.

Contribution

This is a hackathon idea and is still development. We plan to maintain this package for a longer time. Feel free to send us an issue or a pull request!