search

zealdocs / zeal

Offline documentation browser inspired by Dash
https://zealdocs.org
GNU General Public License v3.0
11.49k stars 780 forks source link

Install docsets from command line #509

Open haslinger opened 8 years ago

haslinger commented 8 years ago

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 commented 8 years ago

Not at the moment. You could do it manually by downloading and unpacking docsets, but there's no any CLI support for this task in Zeal yet.

haslinger commented 8 years ago

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 commented 8 years ago

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.

petRUShka commented 7 years ago

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 commented 7 years ago

@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 commented 7 years ago

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

jakoch commented 7 years ago

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 commented 7 years ago

@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 commented 7 years ago

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

cweagans commented 6 years ago

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 commented 6 years ago

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

ssokolow commented 6 years ago

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 commented 6 years ago

@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 commented 6 years ago

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

fmv1992 commented 3 years ago

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

Morpheus636 commented 2 years ago

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 commented 2 years ago

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).