hashira icon indicating copy to clipboard operation
hashira copied to clipboard

Cloud 同期の使い方をドキュメントにする

Open pankona opened this issue 3 years ago • 0 comments

なんとなく動くようになってきたので、使い方のドキュメントを README か何かに書く

書くこと

  • Access Token の取得方法
    • Cloud 同期を使うための準備として、Access Token を準備する必要がある。
    • https://hashira-web.web.app に行ってアクセストークンを発行する。
    • 取得した値を HASHIRA_ACCESS_TOKEN という環境変数に突っ込めば準備 OK。
  • hashira をすでに使っている場合の移行方法
    • これから hashira を使う場合はこのステップは省略してよい。
    • 既存のタスクを同期するためには、すでに登録されているタスクを一度すべてアップロードする必要がある。専用のバイナリ (hashira-web-client) を用意するのでそれを叩く、みたいのを想定。
  • あとは普通に hashira-cui を使っていれば、勝手に変更がアップロードされていく
    • アップロードは「タスクが何かしら変更されたあと 1 分が経過する」ことを条件に実行される。
    • アップロードが行われる後にダウンロードも実行されるが、アップロードからダウンロードの間にいずれかのタスクに変更があった場合、ダウンロードは実行されず、先送りされる。
    • 変更されたタスクがアップロードされ、手元がキレイになった状態であればダウンロードが実行される仕様にしている
    • ダウンロードによって、他所で発生した変更もローカルに取り込まれる

pankona avatar Oct 11 '21 06:10 pankona