https://github.com/rocktakey/rhq
Client for rhq
https://github.com/rocktakey/rhq
emacs emacs-lisp repository-management rhq
Last synced: about 2 months ago
JSON representation
Client for rhq
- Host: GitHub
- URL: https://github.com/rocktakey/rhq
- Owner: ROCKTAKEY
- License: gpl-3.0
- Created: 2022-01-23T09:44:02.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-07-31T15:44:13.000Z (almost 2 years ago)
- Last Synced: 2025-02-08T12:29:58.330Z (4 months ago)
- Topics: emacs, emacs-lisp, repository-management, rhq
- Language: Emacs Lisp
- Homepage:
- Size: 116 KB
- Stars: 0
- Watchers: 2
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.org
- License: LICENSE
Awesome Lists containing this project
README
[[https://github.com/ROCKTAKEY/rhq][https://img.shields.io/github/tag/ROCKTAKEY/rhq.svg?style=flat-square]]
[[file:LICENSE][https://img.shields.io/github/license/ROCKTAKEY/rhq.svg?style=flat-square]]
[[https://codecov.io/gh/ROCKTAKEY/rhq?branch=master][https://img.shields.io/codecov/c/github/ROCKTAKEY/rhq.svg?style=flat-square]]
[[https://github.com/ROCKTAKEY/rhq/actions][https://img.shields.io/github/actions/workflow/status/ROCKTAKEY/rhq/CI.yml.svg?branch=master&style=flat-square]]
* Emacs client for rhq
Use [[https://github.com/ubnt-intrepid/rhq][rhq]] with Emacs!
[[https://github.com/ubnt-intrepid/rhq][Rhq]] is local repository manager like [[https://github.com/x-motemen/ghq][ghq]].
You can clone or create any repositories with ~rhq~ command, and manage them with ~rhq~.
By default, each repository is put in =~/rhq/=, even though repository in other directory can be managed
by using ~rhq add~.
* How to Use?
1. Install rhq
- Run ~M-x rhq-install-executable~ or directly install by the command:
#+BEGIN_SRC shell -n
cargo install rhq
#+END_SRC
2. Create =~/.config/rhq/config.toml= (needed, even allowed to be empty)
#+BEGIN_SRC shell -n
mkdir ~/.config/rhq -p
touch ~/.config/rhq/config.toml
#+END_SRC
3. Clone project by =M-x rhq-clone= or create new project by =M-x rhq-new=.
The argument like "username/repo" means ~git clone https://github.com/username/repo~.
4. Browse projects by =rhq-find-file= or =rhq-open-project=.
- =rhq-find-file= : Find project and find file in it.
- =rhq-open-project= : Find project and open the directory.
5. Enjoy!
* Commands to run rhq
** ~rhq-clone~
:PROPERTIES:
:CUSTOM_ID: rhq-clone
:END:
Clone repository and put it into ~rhq~ management. It takes one argument ~URL~
(and two optional arguments, ~ROOT~ and ~VCS~).
~URL~ can be:
- URL like ~https://github.com/username/repo~
- Abbreviated URL like ~username/repo~ (default host can be set in =config.toml=)
On interactive usage, ~ROOT~ and ~VCS~ can be passed only with prefix argument.
~ROOT~ is directory where the project placed. Note that ~ROOT~ is NOT the name of project directory,
but name of directory in which rhq-managed projects is placed.
By default, =~/rhq/= is used.
~VCS~ is name of version control system which manage the project.
By default, ~git~ is used.
** ~rhq-new~
Create new repository and put it into ~rhq~ management. This function is same as ~rhq-clone~
except first argument can be invalid URL (because this command does NOT clone any repository,
but just create new repository locally). See also [[#rhq-clone]].
** ~rhq-add~
Add local existing project into rhq management.
For example, adding ~./emacs.d~ and other config file is useful.
** ~rhq-refresh~
Refresh rhq cache. Rhq has cache of project list to keep performance of ~rhq list~.
So you should refresh when delete your project, rename project, and so on.
** ~rhq-import~
Import root of projects. In the other words, use the directory as root directory like =~/rhq/=.
All project in it is managed by rhq.
* Commands to browse project managed by rhq
** ~rhq-open-project~
Find project and open the directory.
** ~rhq-open-project-or-clone~
Same as ~rhq-open-project~ except that clone repository if it is not found.
** ~rhq-find-file~
Find project and find file in the directory.
* Projectile integration
You can turn on ~rhq-projectile-mode~ to integrate rhq and [[https://github.com/bbatsov/projectile][projectile]].
It reloads project list from rhq before projectile retrive known project list.
* Consult integration
You can use =rhq-consult-source-project-directory= as source of [[https://github.com/minad/consult][consult]].
For example:
#+begin_src emacs-lisp :tangle yes
(add-to-list 'consult-buffer-sources #'rhq-consult-source-project-directory)
#+end_src
* Commands for developer
** ~rhq-get-project-list~
Return list of projects managed by rhq.
Absolute path is returned by default.
If optional argument ~ROOT~ is non-nil, it should be directory.
Then, this function return relative path when the path is rooted by ~ROOT~.
Note that the path is not rooted by ~ROOT~, it remains absolute path.
* License
This package is licensed by GPLv3. See [[file:LICENSE][LICENSE]].