Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Install docsets from command line #509

Open
haslinger opened this issue Mar 5, 2016 · 17 comments
Open

Install docsets from command line #509

haslinger opened this issue Mar 5, 2016 · 17 comments

Comments

@haslinger
Copy link

Is there a way to install docsets from the command line?
My usecase is writing an install script for automatic installation via bash script for creating a bootable USB-stick-based development environment for Rails Girls Events and similar courses.

P.S.: Zeal is awesome!

@trollixx
Copy link
Member

trollixx commented Mar 7, 2016 via email

@haslinger
Copy link
Author

Thank you @trollixx for your support, perfect. It didn't know that it's that easy, unpacking the .tgz is enough.
I will probably have to cheat a little bit regarding the meta.json and icons, but besides that, it's working for me already!

@trollixx
Copy link
Member

What we need here is a way to mass deploy Zeal settings and/or docsets. It's a quite interesting task, and might come handy in corporate or educational environments. Perhaps the first step would be an ability to dump and load docset lists. Either through UI, CLI-interface, or some other API.

Adding a reference to #400, because these two tasks seems related.

@trollixx trollixx added this to the Some Future Release milestone Sep 30, 2016
@petRUShka
Copy link

Plus one. It is very useful for some automated provision like spark for example.

I fork spark and try to create my own configuration which I can deploy to newly installed PC with several commands. It would be great to be allowed to install zeal docsets by command line in order to write my scriptable configuration.

@multun
Copy link

multun commented Feb 20, 2017

@haslinger Hey there :) I'm from another contest / event that also uses Zeal to provide documentation.
We created this project that you might find helpful => https://bitbucket.org/prologin/envlive/src

I would also be interested in having a command line interface to download docsets, as it is the only unautomated part of our build system.

Thank you :)

@trollixx
Copy link
Member

More people want this, time to prioritise this feature higher I guess...

@jakoch
Copy link

jakoch commented Mar 14, 2017

E.g. a CLI command like zeal --download-docsets mysql, php, js, ts, node, whatnot to download docsets would help a lot. It would allow re-packaging Zeal with docsets included and enable immediate offline usage.

@trollixx
Copy link
Member

@jakoch Nothing prevents you from repackaging Zeal with docsets right now, just make sure to use the proper docset location. Should be even easier with the portable version, since all configuration is stored in a single .ini file.

@jakoch
Copy link

jakoch commented Mar 14, 2017

Doesn't make sense to me =)
Because it means that i have to replicate the work you already did (in an outside packaging script):

  • write a downloader for the docsets
  • extract them into the right location
  • configure them to be found (e.g. configure to work out-of-the-box)
  • plus it adds more work: when you change config logic, i have to change the packaging script, etc.

@cweagans
Copy link

cweagans commented Aug 2, 2018

It would be great to be able to get my list of Zeal docsets into my dotfiles repo so that I can keep them in sync across my workstations!

@justinmk
Copy link

justinmk commented Aug 2, 2018

@cweagans Did you try https://github.com/sunaku/dasht/ ?

@ssokolow
Copy link

ssokolow commented Aug 2, 2018

Unless dasht is guaranteed to be able to make the process of installing docsets for use via Zeal scriptable, it's not very useful.

I want to coninue using Zeal, but I also want to my docsets alongside the lines for apt-get and npm -g and the like in the ubuntu_setup.sh script I'm currently migrating to Ansible.

(Also, I instinctively recoil from any software repository that takes such an informal approach to communication that it sticks emoji in its page titles... and that's before you factor in my dislike for finding garish multi-colored glyphs in positions other than the favicon column in my Tree Style Tab sidebar.)

@cweagans
Copy link

cweagans commented Aug 2, 2018

@justinmk I did not. Looks interesting. I guess I could use that to pull down docsets into the right place, and then just use Zeal as a viewer? Probably wouldn't use the dasht CLI for actually searching docs though.

@ssokolow
Copy link

ssokolow commented Aug 2, 2018

My concern there is that it wouldn't register the docsets with Zeal such that Zeal could check for updates.

@fmv1992
Copy link

fmv1992 commented Sep 26, 2021

Plus one for downloading from the command line. This would make porting current setups easier.

@Morpheus636
Copy link

Morpheus636 commented Feb 20, 2022

I've gone ahead and built this as it's own project using python (but built with pyinstaller so no deps are required - not even python needs to be installed on the system). Linux already works, windows support coming soon.

From my tests, Zeal can update the docsets that I installed through my project just fine.

https://github.com/morpheus636/zeal_cli

@neoh4x0r
Copy link

neoh4x0r commented Mar 21, 2022

It might be nice if zeal included a package-config file so that pkg-config could be used to grab all of the relevant directories (cachedir, configdir, datadir, appdir, etc).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

No branches or pull requests

12 participants